Compare commits

...

2 Commits

Author SHA1 Message Date
kdeng00 517a01d60c Version bump 2025-08-30 13:28:37 -04:00
KD 1ae2f88beb tsk-171: Updated Readme (#181) 2025-08-29 22:14:03 -04:00
3 changed files with 16 additions and 8 deletions
Generated
+1 -1
View File
@@ -840,7 +840,7 @@ dependencies = [
[[package]]
name = "icarus"
version = "0.1.102"
version = "0.2.0"
dependencies = [
"axum",
"axum-extra",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "icarus"
version = "0.1.102"
version = "0.2.0"
edition = "2024"
rust-version = "1.88"
+14 -6
View File
@@ -1,17 +1,25 @@
# Icarus
Web API for the Icarus project.
# Getting Started
## Docker
Make sure `icarus_auth` is located in the root of the parent directory if using docker.
## Getting Started
Quickest way to get started is with docker. Make sure `icarus_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`.
Create a `.env` file for both projects - `icarus_auth` and `icarus` - in the root of each project.
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 api auth_api
docker compose build --ssh default
```
Bring it up
```
docker compose up -d --force-recreate api auth_api
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`.