Skip to content

Commit a07766a

Browse files
author
José Fernando Cordova
committed
update Readme
1 parent d515c62 commit a07766a

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,15 @@
1111

1212
## Environments
1313

14+
### To deploy this api boilerplate, there are three options (yaml) and Docker environments with instructions that you should consider:
15+
16+
### Dev or Local Mode
1417
* docker-compose-dev.yml: generate automatically folders and require-dev dependencies on your local workspace including Xdebug, however the yaml file has a key called:
1518
"XDEBUG_MODE", this yaml by default has the value true (1) to install it.
1619

20+
You can appreciate the dependencies generated automatically on your workspace!
21+
22+
### Play with Docker Mode
1723
* docker-compose-pwd.yml: you can [![Play With Docker](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/jfernancordova/docker-laravel-api-dev/feature/refactoring/docker-compose-pwd.yml), to visualize this environment and test it, however you should see the container lists to verify the HEALTHCHECK.
1824

1925
```bash
@@ -22,7 +28,7 @@ docker ps
2228
# make sure that the docker dockerlaravelapidev_php_1 or php container is (healthy),
2329
normally the process begins in starting mode (health: starting),
2430
```
25-
31+
### Production Mode
2632
* docker-compose-prod.yml: if you are going to use this yaml, make sure to generate the migrations before!, however you can modify the entrypoint to generate them.
2733

2834
## Docker Environments
@@ -45,5 +51,5 @@ docker-compose -f docker-compose-dev.yml up
4551
# wait for the HEALTHCHECK in healthy mode
4652
```
4753

48-
### API Boilerplate Reference
54+
## API Boilerplate Reference
4955
https://github.com/francescomalatesta/laravel-api-boilerplate-jwt/blob/master/readme.md

0 commit comments

Comments
 (0)