Documentation — Noderyx Documentation

01

Meet the framework

Noderyx is a Node.js application framework that ships the parts a real product needs in one system: routing, controllers, Noderframe views, the Cool.css design system, databases, migrations, security, AI providers, and Android/iOS delivery. Nothing here is a plugin you have to assemble.

Server-rendered pages from .noderframe views—readable HTML without client JavaScript.
JSON APIs with sessions, validation, and CSRF already switched on.
MySQL, PostgreSQL, and MongoDB through one model API.
Optional OpenAI or Anthropic intelligence, resolved as a service.
The same views compiled to native Android and iOS widgets.

TERMINAL

npx noderyx-framework new my-app
cd my-app
npm run dev

NOTE

Node.js 20 or newer is required. The framework itself has no runtime dependencies; database drivers are optional.

02

Built for speed, weight, and cost

Noderyx exists because a small product should not need a large machine or a large stack. Pages are server-rendered and cached, the install has no required runtime dependencies, and a modest VPS or shared host is a target rather than a compromise.

Lightspeed: compiled views, cached parses, Brotli and Gzip variants, ETags, and no hydration pass.
Lightweight: no required runtime dependencies; database drivers install only if you use one.
Low-cost hosting: bounded caches, stateless sessions, and one process serving pages, API, and assets.
Mobile friendly first: responsive Cool.css, safe areas, and small HTML on slow connections.
Short working time: live reload, generators, and no build step between writing a view and seeing it.

NOTE

The full reasoning, including the trade-offs, is on the Why Noderyx page.

03

What you need before starting

Noderyx runs anywhere modern Node.js runs: your laptop, a VPS, a container, cPanel, or a platform that reads a Procfile. Device builds add the usual platform toolchains.

Node.js 20+ Required. Check with node --version.

npm Ships with Node.js. Used for scaffolding, scripts, and the framework updater.

A database (optional) MySQL, PostgreSQL, or MongoDB. Skip it entirely for static or API-proxy sites.

Android Studio (optional) Only for building Android apps.

macOS + Xcode (optional) Only for compiling and signing iOS builds.

NOTE

No global installation is required. npx runs the framework CLI straight from npm.

04

A familiar project shape

Every generated project has the same layout, so a Noderyx codebase stays readable to somebody who has never seen it before. Application code is yours; the framework stays in node_modules and never rewrites your files.

PROJECT

my-app/
  app/            Controllers, Models, Middleware, Observers, Commands
  resources/views/ .noderframe views, including errors/
  public/         CSS, JavaScript, images served under /public
  database/       migrations/ and seeders/
  packages/       local packages, discovered automatically
  server.js       the entry point you own
  noderyx.config.js configuration read from the environment
  .env            secrets and per-environment values

NOTE

Keep application code out of node_modules so framework updates stay safe and reversible.

05

Where to go next

The documentation is written to be read in order, but each page stands on its own. Start with the first three, then pick the guide that matches what your product needs this week.

/docs/why Why the framework exists: lightspeed pages, a lightweight install, and low-cost servers.

/docs/creating-project Scaffold an application, pick a database, generate the app key, and run it.

/docs/commands Every CLI command: generators, migrations, builds, keys, and device targets.

/docs/views The Noderframe language: elements, placeholders, conditions, loops, components.

/docs/routing Routes, the request context, controllers, middleware, and error handling.

/docs/database Models, migrations, seeders, and observers across three database engines.

/docs/packages Build, configure, test, and publish reusable Noderyx extensions.

/docs/security What is protected by default and what you must still configure.

/docs/deployment Production mode, Docker, proxies, health checks, and release steps.

06

The commands you will use most

Nearly all day-to-day work runs through a handful of npm scripts that the generator writes into package.json. The full list lives on the Framework commands page.

TERMINAL

npm run dev            # live development server with file watching
npm run noderyx -- make:controller PostController
npm run migrate        # apply pending migrations
npm test               # node --test
npm run build          # render views to static HTML
npm run framework:update  # guarded framework update with rollback

NOTE

npm needs the -- separator before framework arguments: npm run noderyx -- make:model User.

07

Conventions worth knowing early

A few rules explain most of the framework's behavior. Learning them now saves reading later.

Views are .noderframe files. Generated mobile payloads are .mnoderframe and are never edited by hand.
Links are extension-free: /settings/account works on the web, in the packaged app, and in the native navigator.
{{placeholders}} are HTML-escaped by the compiler, so page data cannot inject markup.
Inline event handlers do not run—the Content-Security-Policy has no unsafe-inline. Use data-noderyx attributes or a nonce.
Configuration is read from the environment through noderyx.config.js; code never hardcodes credentials.