Skip to content

Commit 6cf4e9b

Browse files
committed
doc(readme): add docker-compose explanations
1 parent 82be75c commit 6cf4e9b

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ _Note: this project is an exercise_
1010

1111
## Quick Start
1212

13+
There is two ways to start the apps, the first one rely on docker and docker-compose. The second uses bash scripts to run each service via commands.
14+
15+
### Using Docker/Docker-Compose
16+
17+
Prerequisites: docker and docker-compose 3.8+
18+
19+
Run `docker-compose up`
20+
21+
### Manually
22+
1323
Prerequisites: a GNU/Linux Operating System, postgresql 14+, node 14+, python 3.12
1424

1525
To install and run both front and back end, run the following commands:
@@ -19,8 +29,10 @@ To install and run both front and back end, run the following commands:
1929
./run.sh
2030
```
2131

22-
Then, browse [localhost:3000](http://localhost:3000) to open the app.
23-
Or browse [localhost:8000/docs](http://localhost:8000/docs) to access backend documentation.
32+
### Use app
33+
34+
Then, browse [127.0.0.1:3000](http://127.0.0.1:3000) to open the app.
35+
Or browse [127.0.0.1:8000/docs](http://127.0.0.1:8000/docs) to access backend documentation.
2436

2537
The front and back end are located in [`./frontend`](./frontend) and [`./backend`](./backend) folders respectively.
2638
For more information, read [backend's readme](./backend/README.md) and [frontend's readme](./frontend/README.md) go know more about it.
@@ -38,5 +50,5 @@ For more information, read [backend's readme](./backend/README.md) and [frontend
3850
- [ ] Add small icon-buttons to edit/delete/view a sample (only visible when row is hovered)
3951

4052
### Backend
41-
- [ ] Add postres and fastapi to the existing docker-compose.yml
53+
- [x] Add postres and fastapi to the existing docker-compose.yml
4254
- [ ] User Github actions to run pytest with postgres (service)

0 commit comments

Comments
 (0)