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

tsk-171: Updated Readme (#181)

Browse Source
This commit was merged in pull request #181.
This commit is contained in:
KD
2025-08-29 22:14:03 -04:00
committed by GitHub
parent 805df87f5b
commit 1ae2f88beb
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -6
View File
@@ -1,17 +1,25 @@
# Icarus
Web API for the Icarus project.
# Getting Started ## Getting Started
## Docker Quickest way to get started is with docker. Make sure `icarus_auth` and `songparser` repositories
Make sure `icarus_auth` is located in the root of the parent directory if using docker. 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 Build containers
``` ```
docker compose build --ssh default api auth_api docker compose build --ssh default
``` ```
Bring it up 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`.