Requirements

What each package contains

The NestJS API's code is only in the Full Stack package. The Admin Dashboard package runs without it, on sample data kept in your browser.

With Docker

• Docker Desktop on macOS or Windows, or Docker Engine with the Compose plugin on Linux. Both apps start with one docker compose command.
• An internet connection for the first build, which downloads the base images and the dependencies.
• Nothing else: Docker brings Node.js, and the database is a SQLite file inside a Docker volume.

With Docker

• Docker Desktop on macOS or Windows, or Docker Engine on Linux. The dashboard has its own Dockerfile; Compose is not needed.
• An internet connection for the first build, which downloads the base image and the dependencies.

Without Docker

• Node.js 22.9 or newer. Check yours with node -v. The Docker images use Node.js 24.
• Yarn 4, through Corepack. Run corepack enable once; each app pins Yarn 4.8.1 in its package.json, so yarn picks that version. Node.js 25 and newer ship without Corepack: run npm install -g corepack first, then corepack enable.
• No global packages. Each app ships its yarn.lock, so yarn install installs the exact versions the template was tested with.

Database

No database server. The API uses SQLite by default and yarn seed creates the file for you; Docker uses SQLite too. MySQL is supported as a configuration change, not a code change.

• Use MySQL instead

Ports

Each app listens on a fixed local port. Make sure nothing else uses them, or, with Docker, move one with DASHBOARD_PORT or API_PORT in a .env beside docker-compose.yml.

• A port is already in use

Port

The dashboard listens on port 3030. Make sure nothing else uses it, or run it on another one.

• A port is already in use

Optional services

None of these is needed to run the dashboard locally. Each one is switched on by its variables; left empty, its feature stays off and everything else works.

• Configure these services