Theme
Prerequisites
Install these before running anything locally.
Required
| Tool | Minimum | Why |
|---|---|---|
| Node.js | 20.x LTS | Runs both Next.js and the Encore TS runtime. |
| Bun | 1.3+ | Package manager used by the frontend and the docs site. |
| Encore CLI | latest | Builds, runs and deploys the backend. |
| Docker Desktop | latest | Encore boots Postgres containers per service. |
| Git | any recent | Encore uses Git as the deploy transport. |
Install commands
bash
# Node.js — using nvm
nvm install 20
nvm use 20
# Bun
curl -fsSL https://bun.sh/install | bash
# Encore CLI
curl -L https://encore.dev/install.sh | bash
# Docker Desktop — install from https://www.docker.com/products/docker-desktopVerify everything is reachable:
bash
node --version # v20.x.x
bun --version # 1.3+
encore version # Encore CLI version vX.Y.Z
docker --version # Docker version 24+Optional but recommended
| Tool | Use |
|---|---|
| psql | Connect to local Postgres directly. Without it Encore uses Docker. |
| gh (GitHub CLI) | Open PRs and inspect CI from the terminal. |
| VS Code | Repo ships an .vscode/ config with recommended extensions. |
Encore account
For deployment you need an Encore Cloud account:
- Visit https://app.encore.dev and sign in.
- Run
encore auth loginfrom your terminal. - The first deploy will associate the local app with your cloud account.
The free tier is sufficient for development and staging.
Cloning the repo
bash
git clone <your-fork-or-origin>.git n2e
cd n2e/web
ls
# backend/ monitoring_dashboard/ docs/You now have a working tree. Continue to Run the backend.