Skip to content

Commit d05e19f

Browse files
authored
docs: update readme (#53)
1 parent bc06513 commit d05e19f

File tree

3 files changed

+52
-13
lines changed

3 files changed

+52
-13
lines changed

.editorconfig

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.{php,js}]
12+
block_comment_start = /**
13+
block_comment = *
14+
block_comment_end = */
15+
16+
[Makefile]
17+
indent_style = tab

Makefile

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,11 @@ database-create:
2424

2525
.PHONY: database-drop
2626
database-drop:
27-
docker-compose run --rm php bin/console doctrine:database:drop --force
27+
docker-compose run --rm php bin/console doctrine:database:drop --if-exists --force
2828

2929
.PHONY: fixtures-load
3030
fixtures-load:
31-
docker-compose run --rm php bin/console doctrine:fixtures:load
31+
docker-compose run --rm php bin/console doctrine:fixtures:load
32+
33+
.PHONY: reset-db
34+
reset-db: database-drop database-create database-migrate fixtures-load

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Symfony Training
22

3+
This is the boilerplate project for KNP Labs Symfony training.
4+
5+
## Requirements
6+
7+
To run this project with docker you will need:
8+
9+
- [Docker](https://docs.docker.com/get-docker/)
10+
- [Docker Compose](https://docs.docker.com/compose/)
11+
312
## Installation
413

514
```bash
@@ -8,7 +17,7 @@ make start
817

918
### Migrations
1019

11-
One the stack has started, you may apply Doctrine migrations once MySQL is ready.
20+
Once the stack has started, you may apply Doctrine migrations:
1221

1322
```bash
1423
make database-create
@@ -17,15 +26,25 @@ make database-migrate
1726

1827
You can now access the application on [localhost](http://127.0.0.1/login).
1928

29+
### Fixtures
30+
31+
For most of trainings, you will need some fixtures to be loaded. To do so, run:
32+
33+
```bash
34+
make fixtures-load
35+
```
36+
37+
At this point, you should be able to log in and access the application (Email: `[email protected]`, Password: `admin`)
38+
2039
## Commands
2140

22-
| Commands | Description |
23-
|----------------- |-----------------------------------|
24-
| start | Setup and start the stack |
25-
| cp-env | Copie default .env if none exists |
26-
| build | Build Docker's container |
27-
| install-deps | Install Composer dependencies |
28-
| database-create | Create database if none exists |
29-
| database-drop | Drop database |
30-
| database-migrate | Run Doctrine migrations |
31-
| fixtures-load | Load fixtures |
41+
| Commands | Description |
42+
|------------------|-----------------------------------|
43+
| start | Setup and start the stack |
44+
| cp-env | Copie default .env if none exists |
45+
| build | Build Docker's container |
46+
| install-deps | Install Composer dependencies |
47+
| database-create | Create database if none exists |
48+
| database-drop | Drop database |
49+
| database-migrate | Run Doctrine migrations |
50+
| fixtures-load | Load fixtures |

0 commit comments

Comments
 (0)