One object.
A whole backend.
NucleusConfigOptions is the single configuration object you hand to NucleusElysiaPlugin. It turns declarative JSON into a running, secured, multi-tenant API — auth, RBAC, CRUD, payments, realtime and more. This is the deep-dive reference for all 20 of its keys.
// psst — click any key to expand it, just like your config
From JSON to a live API
Nucleus is config-driven: you describe what you want, the framework decides how. The same object documented here is the contract between your declaration and the running service.
1 · Declare
Write config.nucleus.json — one NucleusConfigOptions object describing your database, auth, entities and every feature you want switched on.
2 · Plug in
Pass it to NucleusElysiaPlugin inside any Elysia app. The plugin reads the config, resolves env-var references and wires up the runtime.
3 · Boot
On start Nucleus pushes your Drizzle schema, seeds claims + the godmin, then mounts auth routes, generated CRUD, Swagger and a typed client.
1import { Elysia } from 'elysia'2import { NucleusElysiaPlugin } from 'nucleus-core-ts'3 4new Elysia()5 .use(6 await NucleusElysiaPlugin({7 options: './src/config.json', // NucleusConfigOptions8 schema: './src/drizzle/schema.ts', // generated from entities9 relations: './src/drizzle/relations.ts',10 swagger: { enabled: true, path: '/docs' },11 }),12 )13 .listen(3000)Explore by capability
Eighteen configurable subsystems, grouped by what they do. Open any one for a property-by-property breakdown with examples.
Getting Started
Install, scaffold, generate and mount — from zero to a running API.Core Infrastructure
The non-negotiable foundation every Nucleus app boots with.Identity & Access
Who can sign in, and what they are allowed to touch.Workflow & Governance
Approvals, alerts and the paper trail behind your data.Data Modeling
Declare your domain once; get the whole API for free.Traffic & Observability
Protect, measure and watch your service in real time.External Integrations
The outside world: mail, files, realtime and money.Platform Operations
Operate the running service without a redeploy.Frontend · Client SDK
The auto-generated, type-safe client your UI actually talks to.API Client
Auto-generated, fully type-safe endpoints
config.useApiActionsReady-Made Actions
Auth, sessions, passkeys, CRUD — all pre-built
config.generateAllEndpointsRealtime
WebSocket events, presence & ACK
config.usePubSubServer Fetch
Cookie-aware fetch for RSC & actions
config.serverFetchProxy (BFF)
HTTP + WebSocket reverse proxy
config.ProxyFrontend · Components
Drop-in React UI — wire an action, get a themeable page.Frontend Components
Drop-in, themeable React UI for every feature
config.nucleus-core/feAuth Guard
Client route protection & permission gating
config.LoginChecker / RoleCheckerAuth Pages
Eight pages for the whole credential lifecycle
config.LoginPage / RegisterPage / …Account Pages
Profile, sessions/devices & the admin user console
config.ProfilePage / DevicesPage / UsersPageRBAC Console
Manage roles, claims & row-level scopes
config.AuthorizationPageNotifications UI
Unread bell + paginated notification center
config.NotificationBell / NotificationCenterVerification UI
Visual flow builder, reviewer panel & inbox
config.VerificationFlowPage / VerificationPanelData Components
Entity hook, data grid, form builder & showcase
config.useNucleusEntity / DataTable / FormBuilderForm Inputs & Primitives
The themeable building blocks the pages use
config.Button / SelectBox / NucleusTextInput / …Design System Page
A living component explorer for the kit
config.DesignSystemPage