From 8d251e545f688cc93e7d2216c354de389bacac81 Mon Sep 17 00:00:00 2001 From: Lilleman Date: Thu, 24 Jun 2021 01:59:44 +0200 Subject: [PATCH] Updated README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 8ef6fcc..3140e6d 100644 --- a/README.md +++ b/README.md @@ -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`.