README

simple local PHP development

WARNING: This project started as a PHP project and is still in the process of being ported to Javascript. The Javascript version is mostly untested, unfinished, and undocumented. You might want to wait.

Quick Start

You need Docker and NPM installed.
npm install -g shed-host
Edit your shed .env to specify your sites folder.
shed up -d

Introduction

Shed provides a platform for simple, local, PHP development, in the same kind of way MAMP, Laravel Valet, or Homestead does.

Shed uses Docker, and runs on every platform Docker does.
Shed treats folders as sites, so adding a site is just making a folder.
Shed makes use of wildcard DNS, so no configuration is required to add sites to Shed.
Shed runs real Linux, Apache, MySQL, PostgreSQL and PHP, so your local environment matches production.

It's designed to provide a set-it-and-forget-it platform for local, PHP development.

Setup

To run Shed, you only need to be able to run Docker and NPM. Shed is not tested on Windows yet, but Shed plans to support Windows, Linux, and OS X.

Default Enviroment

There is a .env file in the shed's directory that must be edited by hand for now, until shed config is ported over from the PHP version.

Usage

Start Shed by running shed up or shed up -d. Once it's running, you can access your projects based on their folder names. For example, To access Projects/example.com, I would go to

http://example.com.shed.host

That's it. If you don't want to use shed.host, you can use any of the following:

imarc.io - owned by Imarc
localtest.me - readme.localtest.me
lvh.me - owned by Levi Cook
42foo.com - owned by Jorge Bernal
fuf.me - owned by fidian
lacolhost.com - owned by Reenhanced
vcap.me - part of Cloud Foundry

Shed assumes that the document root for all your projects is <projectfolder>/public. If you use docroot/ instead, you can try creating a symlink like this:

$ ln -s public docroot

How this works

*.shed.host is setup using wildcard DNS to point to 127.0.0.1 - one of the IPs designed to always point to your own local system (localhost.) This eliminates any need to etc your /etc/hosts file.

Within Shed's apache container, it uses mod_vhost_alias to map these subdomains back to separate virtualhosts. This means that there's no new apache configuration required.

Special Subdomains

There are two groups of special domains:

shed.host and www.shed.host get you to Shed's website.
my.shed.host and shed.shed.host get you to Shed's local, internal site. This is where you can find Adminer and Webgrind.

Adminer

Adminer is a lightweight webapp for managing databases, including both MySQL and PostgreSQL. The latest release of Adminer is included in Shed.

You can login by going to http://my.shed.host/ and clicking the relevant link, or:

MySQL: host is mysql, username is root, no password
PostgresSQL: host is postgres, username is postgres, no password

XDebug and Webgrind

XDebug and Webgrind are setup within Shed as well. You can trigger XDebug profiling by adding ?XDEBUG_PROFILE=1 to the end of a URL.

You can view That profile with Webgrind by going to

http://my.shed.host/webgrind/

shedhost / shed

Maintainers

Details