Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
517a01d60c
|
|||
| 1ae2f88beb |
Generated
+1
-1
@@ -840,7 +840,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "icarus"
|
name = "icarus"
|
||||||
version = "0.1.102"
|
version = "0.2.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"axum",
|
"axum",
|
||||||
"axum-extra",
|
"axum-extra",
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "icarus"
|
name = "icarus"
|
||||||
version = "0.1.102"
|
version = "0.2.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
rust-version = "1.88"
|
rust-version = "1.88"
|
||||||
|
|
||||||
|
|||||||
@@ -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`.
|
||||||
|
|||||||
Reference in New Issue
Block a user