NoEgo Framework

Overview

@noego/create generates a NoEgo project with the framework pieces already wired together. Use it to start a full-stack app, an API-only service, or a minimal Express server without hand-copying boilerplate.

Generated projects can include OpenAPI routes, server container setup, database configuration, seed folders, tests, frontend pages, and a local framework guide.

Usage

terminal

npx @noego/create my-app --yes

cd my-app
cp .env.example .env
npm install
npm run reset
npm run dev

Add --port when you want the generated app to use a specific local development port. This writes the default to dev.port in noego.config.yml.

terminal

npx @noego/create my-app --yes --port 3100

For a one-off runtime override, set PORT when starting the dev server, for example PORT=3100 npm run dev.

Templates

full-stack

Express backend, Svelte 5 frontend, OpenAPI wiring, database config, tests, and UI scaffolding.

api-only

Backend, repository, OpenAPI, middleware, database, and integration-test structure without frontend files.

minimal

Smallest Express server with IoC setup and basic project configuration.

Options

--template: Choose full-stack, api-only, or minimal.
--database: Choose sqlite or postgres for database-backed templates.
--jobs: Include the Captain background jobs example.
--port: Set the development server port (default: 3000).
--no-jobs: Explicitly disable the Captain background jobs example.
--no-seeds: Skip generating example seed data.
--force: Overwrite an existing directory without prompting.
--yes: Accept all defaults for non-interactive creation (full-stack + SQLite + seeds + no jobs + port 3000 unless --port is provided).
--help, --version: Show help information or version number.

Back to Documentation Hub