Skip to content

Commit 131ee49

Browse files
author
dmitriy
committed
updated docs and Makefile
1 parent 5ed9f44 commit 131ee49

File tree

7 files changed

+47
-68
lines changed

7 files changed

+47
-68
lines changed

‎.env.dev

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
###> docker-compose configuration ###
2-
COMPOSE_PROJECT_NAME=environment3
3-
###< docker-compose configuration ###
4-
51
APP_NAME=Laravel
62
APP_ENV=dev
73
APP_KEY=base64:KgeWah2LwOk5HLjCYuIZjaQQwX59ASqUjCKZMD6H4Ew=

‎.env.prod

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
###> docker-compose configuration ###
2-
COMPOSE_PROJECT_NAME=environment3
3-
###< docker-compose configuration ###
4-
51
APP_NAME=Laravel
62
APP_ENV=prod
73
APP_KEY=

‎.env.staging

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
###> docker-compose configuration ###
2-
COMPOSE_PROJECT_NAME=environment3
3-
###< docker-compose configuration ###
4-
51
APP_NAME=Laravel
62
APP_ENV=staging
73
APP_KEY=

‎.env.test

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
###> docker-compose configuration ###
2-
COMPOSE_PROJECT_NAME=environment3
3-
###< docker-compose configuration ###
4-
51
APP_NAME=Laravel
62
APP_ENV=test
73
APP_KEY=base64:KgeWah2LwOk5HLjCYuIZjaQQwX59ASqUjCKZMD6H4Ew=

‎.env.test-ci

-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
# by default test environment using .env.test. So all tests will use the same database. If you need to separate it, just use make env-test-ci command and then run migrations and seed.
2-
###> docker-compose configuration ###
3-
COMPOSE_PROJECT_NAME=environment3
4-
###< docker-compose configuration ###
5-
62
APP_NAME=Laravel
73
APP_ENV=test
84
APP_KEY=base64:KgeWah2LwOk5HLjCYuIZjaQQwX59ASqUjCKZMD6H4Ew=

‎Makefile

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
dir=${CURDIR}
2+
export COMPOSE_PROJECT_NAME=environment3
23

34
ifndef APP_ENV
45
# Determine if .env file exist
56
ifneq ("$(wildcard .env)","")
67
include .env
7-
else
8-
export COMPOSE_PROJECT_NAME=environment3
98
endif
109
endif
1110

‎docs/commands.md

+46-46
Original file line numberDiff line numberDiff line change
@@ -6,68 +6,68 @@ This environment comes with "Makefile" and it allow to simplify using some funct
66
In order to use command listed bellow just use next syntax in your local shell: `make {command name}`.
77
Next commands available for this environment:
88
```bash
9-
make build # Build dev environment
10-
make build-test # Build test or continuous integration environment
11-
make build-staging # Build staging environment
12-
make build-prod # Build prod environment
9+
make build # Build dev environment
10+
make build-test # Build test or continuous integration environment
11+
make build-staging # Build staging environment
12+
make build-prod # Build prod environment
1313

14-
make start # Start dev environment
15-
make start-test # Start test or continuous integration environment
16-
make start-staging # Start staging environment
17-
make start-prod # Start prod environment
14+
make start # Start dev environment
15+
make start-test # Start test or continuous integration environment
16+
make start-staging # Start staging environment
17+
make start-prod # Start prod environment
1818

19-
make stop # Stop dev environment
20-
make stop-test # Stop test or continuous integration environment
21-
make stop-staging # Stop staging environment
22-
make stop-prod # Stop prod environment
19+
make stop # Stop dev environment
20+
make stop-test # Stop test or continuous integration environment
21+
make stop-staging # Stop staging environment
22+
make stop-prod # Stop prod environment
2323

24-
make restart # Stop and start dev environment
25-
make restart-test # Stop and start test or continuous integration environment
26-
make restart-staging # Stop and start staging environment
27-
make restart-prod # Stop and start prod environment
24+
make restart # Stop and start dev environment
25+
make restart-test # Stop and start test or continuous integration environment
26+
make restart-staging # Stop and start staging environment
27+
make restart-prod # Stop and start prod environment
2828

29-
make env-dev # Create config for dev environment
30-
make env-test-ci # Create config for test/ci environment
29+
make env-dev # Create config for dev environment
30+
make env-test-ci # Create config for test/ci environment
3131

32-
make ssh # Enter laravel container shell
33-
make ssh-nginx # Enter nginx container shell
34-
make ssh-supervisord # Enter supervisord container shell (cron jobs running there, etc...)
35-
make ssh-mysql # Enter mysql container shell
32+
make ssh # Enter laravel container shell
33+
make ssh-nginx # Enter nginx container shell
34+
make ssh-supervisord # Enter supervisord container shell (cron jobs running there, etc...)
35+
make ssh-mysql # Enter mysql container shell
3636

37-
make exec # Exucute some command defined in cmd="..." variable inside laravel container shell
38-
make exec-bash # Execute several commands defined in cmd="..." variable inside laravel container shell
37+
make exec # Exucute some command defined in cmd="..." variable inside laravel container shell
38+
make exec-bash # Execute several commands defined in cmd="..." variable inside laravel container shell
3939

40-
make report-prepare # Create /reports/coverage folder, will be used for report after running tests
41-
make report-clean # Delete all reports in /reports/ folder
40+
make report-prepare # Create /reports/coverage folder, will be used for report after running tests
41+
make report-clean # Delete all reports in /reports/ folder
4242

43-
make wait-for-db # Checking MySQL database availability, currently using for CircleCI (see /.circleci folder)
43+
make wait-for-db # Checking MySQL database availability, currently using for CircleCI (see /.circleci folder)
4444

45-
make composer-install-prod # Installing composer dependencies for prod environment (without dev tools)
46-
make composer-install # Installing composer dependencies for dev environment
47-
make composer-update # Update composer dependencies
45+
make composer-install-no-dev # Installing composer dependencies for prod/staging environment (without dev tools)
46+
make composer-install # Installing composer dependencies for dev environment
47+
make composer-update # Update composer dependencies
4848

49-
make key-generate # Set the application key
49+
make key-generate # Set the application key
5050

51-
make info # Display information about laravel version and php version
51+
make info # Display information about laravel version and php version
5252

53-
make logs # Display logs for laravel container. Use ctrl+c in order to exit
54-
make logs-nginx # Display logs for nginx container. Use ctrl+c in order to exit
55-
make logs-supervisord # Display logs for supervisord container. Use ctrl+c in order to exit
56-
make logs-mysql # Display logs for mysql container. Use ctrl+c in order to exit
53+
make logs # Display logs for laravel container. Use ctrl+c in order to exit
54+
make logs-nginx # Display logs for nginx container. Use ctrl+c in order to exit
55+
make logs-supervisord # Display logs for supervisord container. Use ctrl+c in order to exit
56+
make logs-mysql # Display logs for mysql container. Use ctrl+c in order to exit
5757

58-
make drop-migrate # Drop databases (main and for tests) and run all migrations
59-
make migrate # Run all migrations for databases (main and for tests)
60-
make migrate-prod # Run all migrations for main database
58+
make drop-migrate # Drop databases (main and for tests) and run all migrations
59+
make migrate # Run all migrations for databases (main and for tests)
60+
make migrate-no-test # Run all migrations for main database
6161

62-
make seed # Run all seeds for test database
62+
make seed # Run all seeds for test database
6363

64-
make phpunit # Run all tests
65-
make report-code-coverage # Update code coverage report on https://coveralls.io (COVERALLS_REPO_TOKEN should be set on CI side)
64+
make phpunit # Run all tests
65+
make report-code-coverage # Update code coverage report on https://coveralls.io (COVERALLS_REPO_TOKEN should be set on CI side)
6666

67-
make phpcs # Run PHP CodeSniffer
68-
make ecs # Run The Easiest Way to Use Any Coding Standard
69-
make ecs-fix # Run The Easiest Way to Use Any Coding Standard to fix issues
70-
phpmetrics # Generates PhpMetrics static analysis
67+
make phpcs # Run PHP CodeSniffer
68+
make ecs # Run The Easiest Way to Use Any Coding Standard
69+
make ecs-fix # Run The Easiest Way to Use Any Coding Standard to fix issues
70+
phpmetrics # Generates PhpMetrics static analysis
7171
```
7272

7373
## Laravel container shell

0 commit comments

Comments
 (0)