Skip to content
Sign in
Buy Nuxter

Docs

Documentation

Build your app on the Nuxter starter kit, one part at a time: what each part does, how to switch it on and configure it, and the code you write against it.

27 pages

Getting started

Press k on any docs page to search.

The docs search, opened with Command K. Typing migration finds four sections, the down arrow moves to Deployment, Ship a migration safely, and Enter opens the page at that section.

Get started

6 pages
Getting started
Create your app from the kit, run it locally with no credentials, make yourself superadmin and find where your own code goes.
Project structure
Where code lives by where it runs, and which server/ directories turn a new file into a route, a job or a provider.
Configuration
starter.config.ts switches each part of the kit and its providers, environment variables hold the secrets: every key and what it changes.
Updating from the kit
Keep the kit as a git remote and take each update as one commit you review, with pnpm template:update, then resolve what conflicts.
Deployment
Ship the app as one Cloudflare Worker: create the resources, set the secrets, deploy main from GitHub Actions or your machine.
MCP server
Connect Claude Code, Cursor or VS Code to https://nuxter.app/mcp, so your agent searches and reads these docs and their design notes.

Accounts

3 pages
Auth
Pick the sign-in methods, add an OAuth provider, protect a route, and handle sessions, second factors and account deletion.
Organizations
Scope routes and pages to an organization, and work with its members, roles, seats, invitations and a second level such as branches.
Roles and permissions
Routes check permissions that an account’s role or its organization’s plan grants: checking one, adding a role, and the staff tools.

Payments

1 page
Payments
Sell plans through Stripe, Polar, Lemon Squeezy or Creem: define plans, connect a provider, gate features, trials, coupons and refunds.

Building blocks

9 pages
Database
Postgres through Drizzle, on Hyperdrive in production and PGlite locally: add a table, query, transactions, migrations and seed data.
Background jobs
Run work after the response on Cloudflare Queues with retries: add and enqueue a job, run jobs locally, and schedule cron tasks.
Events
React to what the kit does by adding a file to server/listeners/, fire events of your own, and look up every event’s payload.
Email
Set up sending, send your own mail with deliverEmail, change the templates and wording, handle unsubscribes and add a provider.
Contact
A /contact page that mails you a message or shows your address after a Turnstile check: choose the channels, set the address, know the limits.
Notifications
The dashboard bell: add a notification type, send one with notify(), and how categories, opt-outs and retention apply.
Storage
Uploads in R2 with one policy per purpose: add a purpose, accept an upload, replace or delete a file, and serve it to its owner.
Feature flags
Declare typed flags in starter.config.ts, read them with flag() or useFlag(), roll them out by rule or percentage, and add a provider.
AI
Call models from server code by role: text, images, speech, transcription, embeddings and video, with provider fallbacks.

Web

4 pages
Security headers
The Content-Security-Policy and hardening headers on every response: allow another origin, keep tokens out of Referer, accept cross-site posts.
Rate limiting
Cap how often a caller hits a route with requireRateLimit, count only failures, space out sends, and protect the zone.
Analytics
Product analytics and ad conversions sent from the server with no browser script: add an event, connect a provider, and handle consent.
Observability
Find a failed request by its id, send faults to Sentry or Better Stack, report an error you caught, and change the error page.

Content and look

3 pages
Blog
Markdown posts with an RSS feed per language, and workflows that draft posts with an AI model and open each one as a pull request.
Languages
Add or remove a language, write copy in the locale files, and write code, refusals and links that follow the reader’s language.
Theme
Change the brand colour and font, and build dashboard sections, list pages, loading placeholders and charts that match the kit.

Quality

1 page
Testing
Unit tests in Node, component tests in a real Nuxt app and Playwright end to end: test a route or a component, and what CI runs.