Skip to content

Commit e2d247f

Browse files
committed
added in readme
1 parent dcfbc05 commit e2d247f

2 files changed

Lines changed: 71 additions & 3 deletions

File tree

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,77 @@ cd frontend
225225
npx cypress run
226226
```
227227

228+
## 9. Running with Docker
229+
230+
The project includes Docker support for the frontend, backend, and PostgreSQL database.
231+
232+
### Requirements
233+
234+
- Docker
235+
- Docker Compose
236+
237+
### Start the application
238+
239+
From the project root directory, run:
240+
241+
```bash
242+
docker compose up --build
243+
```
244+
245+
This command will:
246+
247+
- build the backend image
248+
- build the frontend image
249+
- start a PostgreSQL container
250+
- create the required Docker network
251+
- start all services
252+
253+
Once the containers are running, the application will be available at:
254+
255+
| Service | URL |
256+
|---------|-----|
257+
| Frontend | http://localhost:5173 |
258+
| Backend API | http://localhost:8080 |
259+
| PostgreSQL | localhost:5432 |
260+
261+
### Stop the application
262+
263+
To stop all running containers:
264+
265+
```bash
266+
docker compose down
267+
```
268+
269+
To stop the containers and remove the database volume:
270+
271+
```bash
272+
docker compose down -v
273+
```
274+
275+
## 10. Docker Architecture
276+
277+
```text
278+
+------------------+
279+
| Frontend |
280+
| React + Vite |
281+
+--------+---------+
282+
|
283+
HTTP REST
284+
|
285+
286+
+------------------+
287+
| Backend |
288+
| Spring Boot |
289+
+--------+---------+
290+
|
291+
Spring Data JPA
292+
|
293+
294+
+------------------+
295+
| PostgreSQL |
296+
+------------------+
297+
```
298+
228299
## 11. Configuration
229300
Application configuration is stored in:
230301
- backend/src/main/resources/application.properties

img/video.mp4

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)