Quickstart

Overview

Vantik is an issue tracker for developers and for agents. You host it yourself, because there is no cloud service. The Docker Compose stack in the main repository needs no other setup. It starts the webapp, the API server, and all the services: PostgreSQL, Redis, SuperTokens, and Typesense. The default values work.

How to run it

You need Docker, or Podman with the compose provider.

git clone https://github.com/cmunte132/vantik.git
cd vantik
cp .env.example .env   # the default values work
docker compose up -d

Open http://localhost:3000. Then sign in with any email address. If you configure no SMTP server, the server writes the magic login link to its log and sends no email:

docker compose logs server | grep -A5 "magic link"

There is a second method, and it needs no log. Select Create an account with a passkey. Then authenticate with Touch ID, Windows Hello, or a security key. The server sends no email, so you need no mail server. See How to sign in.

For a deployment like a production one, read How to self-host. That page covers a custom domain, the secrets, and the optional services: SMTP and an AI provider. To run the apps from the source with hot reload, read Local Setup.