Skip to main content

These are the docs for 0.26.0-beta, an older release.

See the current docs (0.26.1-beta) for what Norish does today.
  1. Development
  2. Development setup

Development setup

You need Node.js at the version in .nvmrc, pnpm 12, uv 0.13 or later (it installs the recipe parser's Python 3.15), Docker and Git.

Devcontainer

Open the repository in the devcontainer. It installs the dependencies and starts PostgreSQL, Valkey and Obscura.

cp .env.example .env.local
pnpm run dev

Tip

To customise the devcontainer, copy .devcontainer/default to a new folder next to it. Git only tracks default.

Locally

git clone https://github.com/norish-recipes/norish.git
cd norish

# Also installs the recipe parser's Python environment
pnpm install

cp .env.example .env.local

# Starts PostgreSQL, Valkey and Obscura
pnpm run docker:up

pnpm run dev

.env.local needs at least DATABASE_URL, VALKEY_URL, AUTH_URL and MASTER_KEY, see Server & runtime. .env.example already points OBSCURA_ENDPOINT at the local stack.

Contributing

See the commands, code style and pull request process in CONTRIBUTING.md.