Skip to content

Commit a3f57e3

Browse files
committed
Better readme, including Symfony CLI steps
1 parent 327704c commit a3f57e3

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,27 @@ This application is a PWA (Progressive Web Application) built with Symfony and P
66

77
## Getting Started
88

9+
10+
### With Docker
11+
912
1. If not already done, [install Docker Compose](https://docs.docker.com/compose/install/) (v2.10+)
10-
2. Run `docker compose build --no-cache` to build fresh images
11-
3. Run `docker compose up --pull always -d --wait` to start the project
12-
4. Open `https://localhost` in your favorite web browser and [accept the auto-generated TLS certificate](https://stackoverflow.com/a/15076602/1352334)
13-
5. Run `docker compose down --remove-orphans` to stop the Docker containers.
13+
2. Run `make build` to build fresh images
14+
3. Run `make frontend` to build the frontend assets
15+
4. Run `make up` to start the project
16+
5. Open `https://localhost` in your favorite web browser and [accept the auto-generated TLS certificate](https://stackoverflow.com/a/15076602/1352334)
17+
6. Run `make down` to stop the Docker containers.
18+
19+
### With Symfony CLI
20+
21+
1. If not already done, [install Symfony CLI](https://symfony.com/download)
22+
2. Create a `.env.local` file and set the `DATABASE_URL` environment variable
23+
3. Run `symfony console doctrine:database:create` to create the database
24+
4. Run `symfony console doctrine:migrations:migrate` to create the database schema
25+
5. Run `symfony server:ca:install` to install the TLS certificate
26+
6. Run `symfony server:start` to start the project
27+
7. Run `symfony console tailwind:build` to build the frontend assets
28+
8. Open `https://localhost:8000` in your favorite web browser
29+
9. Run `symfony server:stop` to stop the server
1430

1531
## License
1632

0 commit comments

Comments
 (0)