Rebuild and big update

Author: Evgenii Mykhalichenko

Makefile

@@ -16,6 +16,14 @@ help:
 @echo "Commands:"
 @echo " init Init skeleton settings"
 @echo " help List of all commands in make file"
+@echo " install Install application"
+@echo " add-host Add nginx host to /etc/hosts file"
+@echo " bash Exec backend container"
+@echo " build Build docker-compose"
+@echo " build-no-cache Build docker-compose without cache"
+@echo " up Up with demon docker containers"
+@echo " down Down docker containers"
+@echo " stop Stop docker containers"
 @echo " clear-all-logs Clear all logs in folder /logs"
 @echo " clear-logs-in folder=[FOLDER] Clear logs in folder"
 @echo " watch-log logFilePath=[PATH TO LOG FILE] Watch log file"
@@ -26,6 +34,10 @@ init:
 cp .env_example .env; \
 fi
 
+# make install project
+install: add-host build up
+@${DOCKER} exec -it "${DOCKER_PREFIX}-backend" composer install;
+
 # add nginx host to /etc/hosts file
 add-host:
 SERVICES=$$(command -v getent > /dev/null && echo "getent ahostsv4" || echo "dscacheutil -q host -a name"); \

README.md

@@ -27,31 +27,43 @@ To install, you need to install docker locally.
 * [Docker Compose](https://docs.docker.com/compose/)
 * [Docker Machine](https://docs.docker.com/machine/) (Mac and Windows only)
 
+### Before start work
+
+To run the docker commands without using **sudo** you must add the **docker** group to **your-user**:
+
+```bash
+sudo usermod -aG docker your-user
+```
+
+For now, this project has been mainly created for Unix `(Linux/MacOS)`. Perhaps it could work on Windows.
+
 ### How start work
 
 Clone current project:
 ```bash
 git clone https://github.com/krepysh-spec/lamp-docker-php-skeleton.git && cd lamp-docker-php-skeleton
 ````
+
 Create .env file from .env_example:
 ```bash
 cp .env_example .env
 ````
-Fill configuration in .env file
-
-To run the docker commands without using **sudo** you must add the **docker** group to **your-user**:
-
+or
 ```bash
-sudo usermod -aG docker your-user
-```
+make init
+````
 
-For now, this project has been mainly created for Unix `(Linux/MacOS)`. Perhaps it could work on Windows.
+Fill configuration in .env file
 
+Run bottom command for install application
 ```bash
-docker-compose build && docker-compose up
+make install
 ```
 
-After open in browser [localhost](http://127.0.0.1/)
+If you not change ***NGINX_HOST*** and ***NGINX_PORT*** in ***.env*** open in browser [localhost](http://127.0.0.1/)
+
+And you should see something like:
+![Alt Text](docs/media/result.png)
 
 ### Makefile
 This file helps to quickly interact with the work of docker and additional features.
@@ -62,6 +74,14 @@ usage: make COMMAND
 Commands:
  init Init skeleton settings
  help List of all commands in make file
+ install Install application
+ add-host Add nginx host to /etc/hosts file
+ bash Exec backend container
+ build Build docker-compose
+ build-no-cache Build docker-compose without cache
+ up Up with demon docker containers
+ down Down docker containers
+ stop Stop docker containers
  clear-all-logs Clear all logs in folder /logs
  clear-logs-in folder=[FOLDER] Clear logs in folder
  watch-log logFilePath=[PATH TO LOG FILE] Watch log file
@@ -74,8 +94,6 @@ Commands:
 ├── docker - [Docker settings]
 │   ├── backend
 │   │   ├── Dockerfile
-│   │   ├── cron
-│   │   │   └── crontab
 │   │   ├── php
 │   │   │   └── conf.d
 │   │   │   ├── php.ini
@@ -94,6 +112,14 @@ Commands:
 └── src - [Your workspace]
 ```
 
+### More documentation
+You can also read more information about the project
+
+| Doc | README |
+|----------------------------|--------------------------------------------|
+| xDebug configuration | [docs/xdebug.md](docs/xdebug.md) |
+| Code sniffer configuration | [docs/codesniffer.md](docs/codesniffer.md) |
+
 ### Support
 
 For support, email evgeniymykhalichenko@gmail.com or telegram @krep1sh

docs/codesniffer.md

@@ -0,0 +1,15 @@
+# Setup PHP_CodeSniffer in phpStorm
+The package - [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
+
+CodeSniffer load coding standards from file ***phpcs.xml*** 
+
+- In the ***Settings/Preferences***, navigate to ***PHP | Quality Tools***.
+- On the Quality Tools page that opens, expand the PHP_CodeSniffer area and click the Browse button next to the Configuration list.
+- In the PHP_CodeSniffer dialog that opens, empty the PHP_CodeSniffer path field.
+ ![Alt Text](media/codesniffer/codesniffer1.png)
+ ![Alt Text](media/codesniffer/codesniffer2.png)
+ ![Alt Text](media/codesniffer/codesniffer3.png)
+ ![Alt Text](media/codesniffer/codesniffer4.png)
+- Result
+ ![Alt Text](media/codesniffer/codesniffer5.png)
+