Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
baurnick committed Aug 16, 2024
1 parent 9965bb5 commit 1a54ae6
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ spring.datasource.url=jdbc:postgresql://localhost:5432/yappi_db
```
The project will be running on `http://localhost:8080`.

##### Database setup

Run in your favorite SQL client the following SQL script to create the needed database tables:

`database/01_init.sql`

##### Start the project with docker-compose:
```bash
docker compose up -d
Expand All @@ -48,28 +54,30 @@ If you want to change for example the database name, you can do so in the `docke

The API documentation is available on the following URL: http://localhost:8080/swagger-ui/index.html

### 🛟 Usefull Docker commands
### 🛟 Usefull Docker Commands
List all running container:
```

```bash
docker ps
```

Clean and remove docker images / container

```
```bash
sudo docker stop $(sudo docker ps -q) true
sudo docker rm $(sudo docker ps -a -q) true
sudo docker image rm $(sudo docker images -q) || true
```

View logs of the running container:
```

```bash
docker logs -f <container_id>
```

Delete docker volumes:

```
```bash
docker volumne prune -f
```

Expand Down

0 comments on commit 1a54ae6

Please sign in to comment.