@@ -10,6 +10,16 @@ _Note: this project is an exercise_
10
10
11
11
## Quick Start
12
12
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
+
13
23
Prerequisites: a GNU/Linux Operating System, postgresql 14+, node 14+, python 3.12
14
24
15
25
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:
19
29
./run.sh
20
30
```
21
31
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.
24
36
25
37
The front and back end are located in [ ` ./frontend ` ] ( ./frontend ) and [ ` ./backend ` ] ( ./backend ) folders respectively.
26
38
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
38
50
- [ ] Add small icon-buttons to edit/delete/view a sample (only visible when row is hovered)
39
51
40
52
### Backend
41
- - [ ] Add postres and fastapi to the existing docker-compose.yml
53
+ - [x ] Add postres and fastapi to the existing docker-compose.yml
42
54
- [ ] User Github actions to run pytest with postgres (service)
0 commit comments