Skip to main content

Quickstart

Generate and run an Authenik8 API or connected fullstack application.

Prerequisites​

  • Node.js 18 or newer for the JWT-only Express API preset without Prisma
  • Node.js 20.19+, 22.12+, or 24+ for Prisma-backed API presets and the fullstack preset
  • npm for the fullstack preset
  • Docker (for the Redis and PostgreSQL containers)

Steps​

1. Create App​

npx create-authenik8-app my-app

Choose Full-stack application for the complete App Kit, or select one of the three Express API presets.

Full-stack application​

2. Enter the project​

cd my-app

3. Start services, migrate, and seed​

npm run docker:up
npm run db:migrate
npm run db:seed

4. Run the application​

npm run dev

Open http://localhost:5173. Vite proxies /api to Express on http://localhost:3000.

Express API presets​

After generation:

cd my-app
npm run docker:up
npm run prisma:migrate
npm run dev

The API runs at http://localhost:3000. Skip npm run prisma:migrate only when you selected JWT-only without Prisma.

Notes​

  • Redis is required for refresh rotation, OAuth state, and security features
  • Use --production-ready for PM2/runtime options on Express API presets
  • Use --no-install to generate files without installing dependencies

Resuming an interrupted generation​

npx create-authenik8-app my-app --resume