phoenix/icarus_auth
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 56 Wiki Activity

tsk-68: readme changes

Browse Source
This commit is contained in:
phoenix
2025-10-22 11:40:10 -04:00
parent a51d54d5ef
commit 5bdbfe51d4
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -2,6 +2,13 @@ A auth web API services for the Icarus project.
# Getting Started # Getting Started
Install the `sqlx` tool to use migrations.
```
cargo install sqlx-cli
```
This will be used to scaffold development for local environments.
The easiest way to get started is through docker. This assumes that docker is already installed The easiest way to get started is through docker. This assumes that docker is already installed
on your system. Copy the `.env.docker.sample` as `.env`. Most of the data in the env file doesn't on your system. Copy the `.env.docker.sample` as `.env`. Most of the data in the env file doesn't
need to be modified. The `SECRET_KEY` variable should be changed since it will be used for token need to be modified. The `SECRET_KEY` variable should be changed since it will be used for token