Updating name (#253)
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
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
This commit was merged in pull request #253.
This commit is contained in:
@@ -1,19 +1,19 @@
|
||||
# Icarus
|
||||
Web API for the Icarus project.
|
||||
# soaricarus_api
|
||||
Core web API for the soaricarus project.
|
||||
|
||||
|
||||
### Requires
|
||||
`icarus_auth` v0.8.x
|
||||
`soaricarus_auth` v0.8.x
|
||||
`songparser` v0.6.x
|
||||
|
||||
### Compatible with
|
||||
`icarus-dm` v0.9.x
|
||||
`sidm` v0.10.x
|
||||
|
||||
|
||||
## Getting Started
|
||||
Quickest way to get started is with docker. Make sure `icarus_auth` and `songparser` repositories
|
||||
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 `Icarus`.
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user