Getting Started

Installation

System requirements and installing the CLI.

Crudy is a TypeScript framework. You install the CLI to scaffold new apps and modules, and the framework itself is pulled in as workspace packages by whatever you scaffold.

System requirements

Node.js 20 or later. The provided Docker images use node:24-alpine.
PostgreSQL 14 or later. Production deployments are tested against PostgreSQL 18 (the image used in the generated docker-compose.yml).
Docker and Docker Compose, if you plan to use the bundled dev stack.
Git, for version control of your app.

Installing the CLI

The CLI ships as @crudy/cli and exposes a single binary called crudy.

bash

npm install -g @crudy/cli

If you would rather not install globally, you can run it ad hoc:

bash

npx @crudy/cli create my-app

Verify the installation:

bash

crudy --version

What the framework itself ships as

You do not install the framework directly. When you scaffold an app the generated package.json files depend on the published workspace packages:

@crudy/backend for the Fastify server factory.
@crudy/frontend for the Next.js providers, pages, and middleware helpers.
Optional @crudy-modules/* packages for any modules you wire in.

A first npm install from inside the scaffolded app pulls everything in.

Note

The framework runs against PostgreSQL with the pgmorbac extension. The provided Docker images install it automatically. If you run Postgres outside Docker, install the extension before booting the backend or the first migration will fail.

Next step

Once crudy --version reports a version, continue with Quickstart to scaffold and run an app.

System requirements

Node.js 20 or later. The provided Docker images use node:24-alpine.

PostgreSQL 14 or later. Production deployments are tested against PostgreSQL 18 (the image used in the generated docker-compose.yml).

Docker and Docker Compose, if you plan to use the bundled dev stack.

Git, for version control of your app.

What the framework itself ships as

You do not install the framework directly. When you scaffold an app the generated package.json files depend on the published workspace packages:

@crudy/backend for the Fastify server factory.

@crudy/frontend for the Next.js providers, pages, and middleware helpers.

Optional @crudy-modules/* packages for any modules you wire in.

A first npm install from inside the scaffolded app pulls everything in.

Note