Getting started
Quickstart
Run Ticqex locally in three commands.
Prerequisites
- Node 20+
- Docker (for local Supabase)
Install and run
pnpm install
pnpm ticqex init # interactive: local Supabase, channels, env
pnpm devOpen http://localhost:3000, sign in with the SEED_ADMIN_* credentials from .env.local, and confirm http://localhost:3000/api/health returns "database":"ok".
What init does
- Supabase — choose
localto start Docker Supabase, write its keys to.env.local, bootstrap required board data, and optionally seed an admin user. Chooseskipif the database is already set up (pnpm ticqex init --supabase skip). - Email — on by default. For UI/API/MCP-only work, answer no when asked to enable the email channel. With email on, init asks for your Resend API key, sender details, and webhook URL — see Email channel.
- Config — init may update
config/ticqex.config.json, the committed activation file that controls which channels and integrations are on (config/ticqex.config.example.jsonis the template).
pnpm ticqex init is local-only; for production see Deploy.
Next steps
- Set up the email channel so inbound mail becomes tickets.
- Learn the board and tickets.
- Connect an AI agent over API or MCP.