pwrpln/auth-api
3
0
Fork 0
Code Pull Requests Actions Releases Activity

Updated README

Browse Source
This commit is contained in:
Lilleman auf Larv 2021-06-24 01:59:44 +02:00
parent 880a384f35
commit 8d251e545f
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,6 +2,14 @@
This is a tiny http API for auth. Register accounts, auth with api-key or name/password, renew JWT tokens...
## Quick start with docker compose
Migrate database: `docker-compose run --rm db-migrations`
Run tests: `docker-compose run --rm tests`
Start the service (on port 4000 by default): `docker-compose up -d` (db migrations must be ran before this)
## Databaes migration
Done using [dbmate](https://github.com/amacneil/dbmate). Db stuff is stored in `./db`.