Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit b99d4f0

Browse files
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.
1 parent a346bdb commit b99d4f0

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

‎README.md‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ ___
3636

3737
## Install prerequisites
3838

39+
To run the docker commands without using **sudo** you must add the **docker** group to **your-user**:
40+
41+
```
42+
sudo usermod -aG docker your-user
43+
```
44+
3945
For now, this project has been mainly created for Unix `(Linux/MacOS)`. Perhaps it could work on Windows.
4046

4147
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.
145151
1. Generate SSL certificates
146152

147153
```sh
148-
source .env && sudo docker run --rm -v $(pwd)/etc/ssl:/certificates -e "SERVER=$NGINX_HOST" jacoelho/generate-certificate
154+
source .env && docker run --rm -v $(pwd)/etc/ssl:/certificates -e "SERVER=$NGINX_HOST" jacoelho/generate-certificate
149155
```
150156

151157
2. Configure Nginx
@@ -198,13 +204,13 @@ ___
198204
2. Start the application :
199205

200206
```sh
201-
sudo docker-compose up -d
207+
docker-compose up -d
202208
```
203209

204210
**Please wait this might take a several minutes...**
205211

206212
```sh
207-
sudo docker-compose logs -f # Follow log output
213+
docker-compose logs -f # Follow log output
208214
```
209215

210216
3. Open your favorite browser :
@@ -216,7 +222,7 @@ ___
216222
4. Stop and clear services
217223

218224
```sh
219-
sudo docker-compose down -v
225+
docker-compose down -v
220226
```
221227

222228
___
@@ -245,7 +251,7 @@ When developing, you can use [Makefile](https://en.wikipedia.org/wiki/Make_(soft
245251
Start the application :
246252

247253
```sh
248-
sudo make docker-start
254+
make docker-start
249255
```
250256

251257
Show help :
@@ -261,57 +267,57 @@ ___
261267
### Installing package with composer
262268

263269
```sh
264-
sudo docker run --rm -v $(pwd)/web/app:/app composer require symfony/yaml
270+
docker run --rm -v $(pwd)/web/app:/app composer require symfony/yaml
265271
```
266272

267273
### Updating PHP dependencies with composer
268274

269275
```sh
270-
sudo docker run --rm -v $(pwd)/web/app:/app composer update
276+
docker run --rm -v $(pwd)/web/app:/app composer update
271277
```
272278

273279
### Generating PHP API documentation
274280

275281
```sh
276-
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
282+
docker run --rm -v $(pwd):/data phpdoc/phpdoc -i=vendor/ -d /data/web/app/src -t /data/web/app/doc
277283
```
278284

279285
### Testing PHP application with PHPUnit
280286

281287
```sh
282-
sudo docker-compose exec -T php ./app/vendor/bin/phpunit --colors=always --configuration ./app
288+
docker-compose exec -T php ./app/vendor/bin/phpunit --colors=always --configuration ./app
283289
```
284290

285291
### Fixing standard code with [PSR2](http://www.php-fig.org/psr/psr-2/)
286292

287293
```sh
288-
sudo docker-compose exec -T php ./app/vendor/bin/phpcbf -v --standard=PSR2 ./app/src
294+
docker-compose exec -T php ./app/vendor/bin/phpcbf -v --standard=PSR2 ./app/src
289295
```
290296

291297
### Checking the standard code with [PSR2](http://www.php-fig.org/psr/psr-2/)
292298

293299
```sh
294-
sudo docker-compose exec -T php ./app/vendor/bin/phpcs -v --standard=PSR2 ./app/src
300+
docker-compose exec -T php ./app/vendor/bin/phpcs -v --standard=PSR2 ./app/src
295301
```
296302

297303
### Analyzing source code with [PHP Mess Detector](https://phpmd.org/)
298304

299305
```sh
300-
sudo docker-compose exec -T php ./app/vendor/bin/phpmd ./app/src text cleancode,codesize,controversial,design,naming,unusedcode
306+
docker-compose exec -T php ./app/vendor/bin/phpmd ./app/src text cleancode,codesize,controversial,design,naming,unusedcode
301307
```
302308

303309
### Checking installed PHP extensions
304310

305311
```sh
306-
sudo docker-compose exec php php -m
312+
docker-compose exec php php -m
307313
```
308314

309315
### Handling database
310316

311317
#### MySQL shell access
312318

313319
```sh
314-
sudo docker exec -it mysql bash
320+
docker exec -it mysql bash
315321
```
316322

317323
and
@@ -327,27 +333,27 @@ mkdir -p data/db/dumps
327333
```
328334

329335
```sh
330-
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"
336+
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"
331337
```
332338

333339
#### Restoring a backup of all databases
334340

335341
```sh
336-
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"
342+
source .env && docker exec -i $(docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" < "data/db/dumps/db.sql"
337343
```
338344

339345
#### Creating a backup of single database
340346

341347
**`Notice:`** Replace "YOUR_DB_NAME" by your custom name.
342348

343349
```sh
344-
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"
350+
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"
345351
```
346352

347353
#### Restoring a backup of single database
348354

349355
```sh
350-
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"
356+
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"
351357
```
352358

353359

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /