Update README

- Remove sudo for docker commands
- Replacement of the documentation generator by PHPDoc
  Too many problems with "apigen" dependencies and it seems to not be maintained.

Author: nanoninja

README.md

@@ -36,6 +36,12 @@ ___
 
 ## Install prerequisites
 
+To run the docker commands without using **sudo** you must add the **docker** group to **your-user**:
+
+```
+sudo usermod -aG docker your-user
+```
+
 For now, this project has been mainly created for Unix `(Linux/MacOS)`. Perhaps it could work on Windows.
 
 All requisites should be available for your distribution. The most important are :
@@ -145,7 +151,7 @@ If you modify the host name, do not forget to add it to the `/etc/hosts` file.
 1. Generate SSL certificates
 
     ```sh
-    source .env && sudo docker run --rm -v $(pwd)/etc/ssl:/certificates -e "SERVER=$NGINX_HOST" jacoelho/generate-certificate
+    source .env && docker run --rm -v $(pwd)/etc/ssl:/certificates -e "SERVER=$NGINX_HOST" jacoelho/generate-certificate
     ```
 
 2. Configure Nginx
@@ -198,13 +204,13 @@ ___
 2. Start the application :
 
     ```sh
-    sudo docker-compose up -d
+    docker-compose up -d
     ```
 
     **Please wait this might take a several minutes...**
 
     ```sh
-    sudo docker-compose logs -f # Follow log output
+    docker-compose logs -f # Follow log output
     ```
 
 3. Open your favorite browser :
@@ -216,7 +222,7 @@ ___
 4. Stop and clear services
 
     ```sh
-    sudo docker-compose down -v
+    docker-compose down -v
     ```
 
 ___
@@ -245,7 +251,7 @@ When developing, you can use [Makefile](https://en.wikipedia.org/wiki/Make_(soft
 Start the application :
 
 ```sh
-sudo make docker-start
+make docker-start
 ```
 
 Show help :
@@ -261,57 +267,57 @@ ___
 ### Installing package with composer
 
 ```sh
-sudo docker run --rm -v $(pwd)/web/app:/app composer require symfony/yaml
+docker run --rm -v $(pwd)/web/app:/app composer require symfony/yaml
 ```
 
 ### Updating PHP dependencies with composer
 
 ```sh
-sudo docker run --rm -v $(pwd)/web/app:/app composer update
+docker run --rm -v $(pwd)/web/app:/app composer update
 ```
 
 ### Generating PHP API documentation
 
 ```sh
-sudo docker-compose exec -T php php -d memory_limit=256M -d xdebug.profiler_enable=0 ./app/vendor/bin/apigen generate app/src --destination ./app/doc
+docker run --rm -v $(pwd):/data phpdoc/phpdoc -i=vendor/ -d /data/web/app/src -t /data/web/app/doc
 ```
 
 ### Testing PHP application with PHPUnit
 
 ```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpunit --colors=always --configuration ./app
+docker-compose exec -T php ./app/vendor/bin/phpunit --colors=always --configuration ./app
 ```
 
 ### Fixing standard code with [PSR2](http://www.php-fig.org/psr/psr-2/)
 
 ```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpcbf -v --standard=PSR2 ./app/src
+docker-compose exec -T php ./app/vendor/bin/phpcbf -v --standard=PSR2 ./app/src
 ```
 
 ### Checking the standard code with [PSR2](http://www.php-fig.org/psr/psr-2/)
 
 ```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpcs -v --standard=PSR2 ./app/src
+docker-compose exec -T php ./app/vendor/bin/phpcs -v --standard=PSR2 ./app/src
 ```
 
 ### Analyzing source code with [PHP Mess Detector](https://phpmd.org/)
 
 ```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpmd ./app/src text cleancode,codesize,controversial,design,naming,unusedcode
+docker-compose exec -T php ./app/vendor/bin/phpmd ./app/src text cleancode,codesize,controversial,design,naming,unusedcode
 ```
 
 ### Checking installed PHP extensions
 
 ```sh
-sudo docker-compose exec php php -m
+docker-compose exec php php -m
 ```
 
 ### Handling database
 
 #### MySQL shell access
 
 ```sh
-sudo docker exec -it mysql bash
+docker exec -it mysql bash
 ```
 
 and
@@ -327,27 +333,27 @@ mkdir -p data/db/dumps
 ```
 
 ```sh
-source .env && sudo docker exec $(sudo docker-compose ps -q mysqldb) mysqldump --all-databases -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" > "data/db/dumps/db.sql"
+source .env && docker exec $(docker-compose ps -q mysqldb) mysqldump --all-databases -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" > "data/db/dumps/db.sql"
 ```
 
 #### Restoring a backup of all databases
 
 ```sh
-source .env && sudo docker exec -i $(sudo docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" < "data/db/dumps/db.sql"
+source .env && docker exec -i $(docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" < "data/db/dumps/db.sql"
 ```
 
 #### Creating a backup of single database
 
 **`Notice:`** Replace "YOUR_DB_NAME" by your custom name.
 
 ```sh
-source .env && sudo docker exec $(sudo docker-compose ps -q mysqldb) mysqldump -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" --databases YOUR_DB_NAME > "data/db/dumps/YOUR_DB_NAME_dump.sql"
+source .env && docker exec $(docker-compose ps -q mysqldb) mysqldump -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" --databases YOUR_DB_NAME > "data/db/dumps/YOUR_DB_NAME_dump.sql"
 ```
 
 #### Restoring a backup of single database
 
 ```sh
-source .env && sudo docker exec -i $(sudo docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" < "data/db/dumps/YOUR_DB_NAME_dump.sql"
+source .env && docker exec -i $(docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" < "data/db/dumps/YOUR_DB_NAME_dump.sql"
 ```