Skip to content

Commit 311e399

Browse files
committed
Updates README files
1 parent 73e263d commit 311e399

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
11
# docker-compose-laravel
2-
A pretty simplified docker-compose workflow that sets up a LEMP network of containers for local Laravel development. You can view the full article that inspired this repo [here](https://medium.com/@aschmelyun).
2+
A pretty simplified docker-compose workflow that sets up a LEMP network of containers for local Laravel development. You can view the full article that inspired this repo [here](https://dev.to/aschmelyun/the-beauty-of-docker-for-local-laravel-development-13c0).
33

44

55
## Usage
66

77
To get started, make sure you have [Docker installed](https://docs.docker.com/docker-for-mac/install/) on your system, and then clone this repository.
88

9-
First add your entire Laravel project to the `src` folder, then open a terminal and from this cloned respository's root run `docker-compose up -d --build`. Open up your browser of choice to [http://localhost:8080](http://localhost:8080) and you should see your Laravel app running as intended. **Your Laravel app needs to be in the src directory first before bringing the containers up, otherwise the artisan container will not build, as it's missing the appropriate file.**
9+
Next, navigate in your terminal to the directory you cloned this, and spin up the containers for the web server by running `docker-compose up -d --build site`.
1010

11-
**New:** Three new containers have been added that handle Composer, NPM, and Artisan commands without having to have these platforms installed on your local computer. Use the following command templates from your project root, modifiying them to fit your particular use case:
11+
After that completes, follow the steps from the [src/README.md](src/README.md) file to get your Laravel project added in (or create a new blank one).
1212

13-
- `docker-compose run --rm composer update`
14-
- `docker-compose run --rm npm run dev`
15-
- `docker-compose run --rm artisan migrate`
16-
17-
Containers created and their ports (if used) are as follows:
13+
Bringing up the Docker Compose network with `site` instead of just using `up`, ensures that only our site's containers are brought up at the start, instead of all of the command containers as well. The following are built for our web server, with their exposed ports detailed:
1814

1915
- **nginx** - `:8080`
2016
- **mysql** - `:3306`
2117
- **php** - `:9000`
22-
- **npm**
23-
- **composer**
24-
- **artisan**
18+
19+
Three additional containers are included that handle Composer, NPM, and Artisan commands *without* having to have these platforms installed on your local computer. Use the following command examples from your project root, modifying them to fit your particular use case.
20+
21+
- `docker-compose run --rm composer update`
22+
- `docker-compose run --rm npm run dev`
23+
- `docker-compose run --rm artisan migrate`
2524

2625
## Persistent MySQL Storage
2726

src/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
# Your Laravel app goes in here
1+
## This is where your Laravel app goes
2+
3+
To get started, delete this file and then do one of the following:
4+
5+
- Clone your project or copy all of the files directly into this `src` directory.
6+
- Spin up the Docker network by following the instructions on the main [README.md](../README.md), and install a brand new Laravel project by running `docker-compose run --rm composer create-project laravel/laravel .` in your terminal.

0 commit comments

Comments
 (0)