Documentation

Everything you need to ship on Neutron.

Guides for the TypeScript meta-framework, per-language SDKs, and the Nucleus database engine. Jump in where you are — nothing here assumes you've read anything else first.

Get started in minutes

Spin up a new Neutron project in one command. Covers Node, Bun, and Deno.

Your first route

File-based routing, loaders, and actions in under 20 lines of code.

Project structure

What goes where and why. Runtime entry points, route modules, content collections.

TypeScript framework

Static, app, and dynamic routes. Nested layouts, error boundaries, file conventions.

Loaders, actions, forms, revalidation. End-to-end type safety from the handler to the component.

Rendering modes

Static, SSR, islands, view transitions. Pick the right mode per route.

Content collections

Markdown + MDX with typed frontmatter, schemas, and first-class query helpers.

Global and per-route middleware. Request context, auth gates, rate limits.

Node, Cloudflare, Vercel, Docker, static hosting. One build, many targets.

Nucleus database

One engine, fourteen data models. PostgreSQL wire compatible so any client just works.

How Nucleus packs SQL, KV, Vector, Graph, Documents, TimeSeries, and nine more into a single process.

Connect from psql, run a query across two data models in one transaction.

PostgreSQL dialect, extended with functions that reach into every other model.

HNSW and IVFFlat indexes. SIMD distance functions. Hybrid SQL + vector queries.

Multi-Raft replication, read replicas, and disaster recovery runbook.

Auth, roles, row-level security, audit logs. Production defaults, not checklists.

Language SDKs

Eight SDKs, one contract. Same wire protocol, same error format, same health checks — in the idioms of each language.

Hyper + Tokio. Trie router, 18 crates, full auth.

net/http, idiomatic router, OAuth + WebAuthn.

Starlette + Pydantic v2 + asyncpg, async-first.

Plug + Bandit, OTP supervisors, hot reload.

12 KB binary, zero heap, comptime SQL validation.

DifferentialEquations.jl, CUDA, FMI interop.

GPU kernels, quantized inference, training stack.

Platforms & tools

Native (iOS/Android)

Preact components that render to native Fabric views.

Create, dev, build, deploy, db, studio — one binary.

Visual browser for every Nucleus data model.

Machine-checked proofs across Lean 4, Quint, Verus.

API reference

loader, action, head, config, middleware.

Island, ViewTransitions, Outlet.

useLoaderData, useActionData, useFormState.

Server utilities

redirect, json, error helpers, cookies, CSRF.

getCollection, getEntry, defineCollection, schemas.