From 3ad0d8a3fd4f5c61cabb66a1e40d01b2321e4b77 Mon Sep 17 00:00:00 2001 From: kdeng00 Date: Mon, 25 Aug 2025 15:05:02 -0400 Subject: [PATCH] tsk-171: Updated Readme --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ca22c83..58298aa 100644 --- a/README.md +++ b/README.md @@ -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`.