README.md

Railnode documentation

Start here if you’re new to the repo or to Railnode.

Core concepts

• Getting started
• Models + automatic CRUD routes
• Manual routes (route loader)
• Database adapters (switching storage)
• Backend configuration
• CLI reference
• Troubleshooting

Mental model

Railnode boots an Express app and then:

1. Loads model modules from modelsDir (defaults to dist/models then src/models).
2. (Optional) Generates CRUD routes for every registered model.
3. Loads route modules from routesDir (defaults to dist/routes then src/routes).

Model files register themselves at import-time via defineModel(...). Route files are auto-mounted when they export both basePath and a default express.Router.