Getting Started
Create a VitNode app, start Postgres, run the dev server, and sign in to the AdminCP as your first administrator.
Get up and running with a complete VitNode application in under 5 minutes.
Prerequisites
- Node.js 22+ (Node 24 recommended)
- Package manager: pnpm, bun, or npm
- PostgreSQL 15+ (or Docker to run the included compose file)
Create and Run Your Application
1. Scaffold the Project
Create VitNode app
bun create vitnode-app@canarypnpm create vitnode-app@canarynpx create-vitnode-app@canarySelect your preferred template when prompted:
- Single App: Unified TanStack Start application with Hono API mounted at
/api(Recommended). - Monorepo App: Turborepo setup separating
apps/webandapps/api. - Only API: Standalone Hono REST/RPC server.
2. Start PostgreSQL with Docker
If you chose Docker during scaffolding, start Postgres and Redis in one command:
Start database
bun run docker:devpnpm docker:devnpm run docker:dev3. Run Migrations and Seed Initial Admin
Migrate and seed
bun run db:migratepnpm db:migratenpm run db:migrateThis creates all core schema tables and prompts you to configure your initial administrator account.
4. Start the Development Server
Start dev server
bun devpnpm devnpm run devOpen http://localhost:3000 to view your live application.
5. Sign In to the AdminCP
Visit http://localhost:3000/admin and sign in with the admin credentials created during migration.