phoenix
59a7e31641
soaricarus_api CI / Check (push) Successful in 3m21s
soaricarus_api CI / Test Suite (push) Successful in 4m25s
soaricarus_api CI / Rustfmt (push) Successful in 3m8s
soaricarus_api CI / Clippy (push) Successful in 3m56s
soaricarus_api CI / build (push) Successful in 3m3s
Reviewed-on: #253
34 lines
989 B
Markdown
34 lines
989 B
Markdown
# soaricarus_api
|
|
Core web API for the soaricarus project.
|
|
|
|
|
|
### Requires
|
|
`soaricarus_auth` v0.8.x
|
|
`songparser` v0.6.x
|
|
|
|
### Compatible with
|
|
`sidm` v0.10.x
|
|
|
|
|
|
## Getting Started
|
|
Quickest way to get started is with docker. Make sure `soaricarus_auth` and `songparser` repositories
|
|
are located in the root of the parent directory. Check the respective repositories to ensure they
|
|
are setup correctly before configuring `soaricarus_api`.
|
|
|
|
Copy the `.env.docker.sample` file to `.env`. Ensure that the `ROOT_DIRECTORY` variable is populated
|
|
and exists on the docker image's filesystem. The credentials for the database doesn't need to be
|
|
changed for development, but if deploying it, it should be modified.
|
|
|
|
Build containers
|
|
```
|
|
docker compose build --ssh default
|
|
```
|
|
|
|
Bring it up
|
|
```
|
|
docker compose up -d --force-recreate
|
|
```
|
|
|
|
To view the OpenAPI spec, run the project and access `/swagger-ui`. If running through docker,
|
|
the url would be something like `http://localhost:8000/swagger-ui`.
|