phoenix/soaricarus_api
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 33 Wiki Activity

Updating name
Rust CI / Rustfmt (pull_request) Successful in 2m25s
Details
Rust CI / Test Suite (pull_request) Successful in 3m44s
Details
Rust CI / Check (pull_request) Successful in 5m42s
Details
Rust CI / build (pull_request) Successful in 6m40s
Details
Rust CI / Clippy (pull_request) Successful in 7m58s
Details

Browse Source
This commit is contained in:
phoenix
2026-07-17 16:52:07 -04:00
parent 8a64a71339
commit 2afce82682
8 changed files with 71 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -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
`soaricarus-dm` v0.9.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