From 9abc89269868ecfc3d124487e8ee684b14df85c1 Mon Sep 17 00:00:00 2001 From: Nabeel Shahzad Date: Tue, 25 May 2021 15:11:09 -0400 Subject: [PATCH] Update README --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f7315d84..1d298344 100755 --- a/README.md +++ b/README.md @@ -30,15 +30,16 @@ A full distribution, with all of the composer dependencies, is available at this [View installation details](https://docs.phpvms.net/installation/installation) -## Development Environment +## Development Environment with Docker -A full development environment can be brought up using Docker: +A full development environment can be brought up using Docker, without having to install composer/npm locally ```bash -composer install -npm install -docker-compose build -docker-compose up +make docker-test + +# **OR** with docker-compose directly + +docker-compose -f docker-compose.yml -f docker-compose.local.yml up ``` Then go to `http://localhost`. If you're using dnsmasq, the `app` container is listening on `phpvms.test`, or you can add to your `/etc/hosts` file: @@ -47,6 +48,8 @@ Then go to `http://localhost`. If you're using dnsmasq, the `app` container is l 127.0.0.1 phpvms.test ``` +The `docker-compose.local.yml` overrides the `app` section in `docker-compose.yml`. The standard `docker-compose.yml` can be used if you want to deploy from the image, or as a template for your own Dockerized deployments. + ### Building JS/CSS assets Yarn is required, run: