Skip to content

Prerequisites

This starter kit needs Git, Node.js 24 or newer, pnpm 11.3.0, and MongoDB. On Windows, install MongoDB Community Server directly; on macOS and Linux, run it with Docker Compose. A GitHub account is only needed if you plan to publish the repository or deploy the documentation site.

Git and Node.js

Node.js 24+ is required.

winget install --id Git.Git
winget install -e --id OpenJS.NodeJS

brew install git node

sudo apt install git

Install Node.js 24 or newer from the official Node.js downloads and verify node --version. The distribution package may be older than the required version.

node --version

sudo dnf install git

Install Node.js 24 or newer from the official Node.js downloads and verify node --version. The distribution package may be older than the required version.

node --version

Official install instructions: Git ยท Node.js

pnpm

The repository pins pnpm 11.3.0 in the root package.json.

npm install --global pnpm@11.3.0

Verify each with:

git --version
node --version
npm --version
pnpm --version

Official install instructions: pnpm

MongoDB

Download MongoDB Community Server for Windows as an MSI. In the installer, choose Complete and keep Install MongoD as a Service selected. The service starts when installation finishes and listens on 127.0.0.1:27017 by default.

mongosh is optional for this project; install it separately only if you want a database shell.

Install Docker Desktop (macOS) or Docker Engine with the Compose plugin (Linux). Docker runs the local MongoDB server and is also used by the full-stack deployment example.

docker compose version

An editor

Use any editor with TypeScript support. The repository includes shared settings in .vscode/; Biome handles formatting and linting from the workspace root.

Next steps

Continue to Installation.

References