Getting started

Choose the path that matches your project.

Create a new projectStart from the canonical FrameKit Next.js template.

Integrate an existing projectAdd FrameKit to an existing Next.js App Router application.

Requirements

• Node.js >=22.13.0.
• pnpm >=11.14.0 when using pnpm.
• Existing applications must use Next.js >=16 <17, React >=19 <20, and React DOM >=19 <20.

The workflow

1. Set up the application. Create a new project or integrate an existing one.
2. Add templates under src/templates/.
3. Generate and validate the registry. FrameKit writes the generated clients and template registry.
4. Open Studio. Use the generated application to edit and export your templates.

Caution

Do not edit src/generated/framekit/, public/framekit/, or .framekit/ by hand. They are generated output. Keep .framekit-data/ persistent only when authentication is enabled and the default SQLite database is in use.

Authentication is disabled by default. Set FRAMEKIT_AUTH_ENABLED=true explicitly before exposing production to an untrusted network; open mode does not initialize SQLite or create an anonymous administrator.

After setup, read Project structure and then build your first template.