docs: improve readme

This commit is contained in:
Bastien Riviere 2024-01-29 22:25:40 +01:00
parent 8d29ab9a9c
commit 1d09d445af
Signed by: babariviere
GPG key ID: 4E5F0839249F162E

View file

@ -26,3 +26,20 @@ docker compose up -d
just migrate # or atlas migrate apply --env local just migrate # or atlas migrate apply --env local
go run . go run .
``` ```
## Accessing the docs
The docs is using the `openapi.yaml` provided in the root directory. A web UI is available at http://localhost:8080/docs.
It's using Rapidoc under the hood.
## Testing
You can simply test using:
```sh
# ensure postgres is up
docker compose up -d
go test ./...
```
It will create database on the fly for each test.