Requirements

What each package contains

A single-app package does not include the other apps. The website and the dashboard read everything from the Hollina API, and the API's code is only in the Full Stack and Backend API packages.

With Docker

• Docker Desktop on macOS or Windows, or Docker Engine with the Compose plugin on Linux, with Docker Compose 2.24 or newer, which every current Docker Desktop includes; docker compose version prints yours. The full stack starts with one docker compose command, and docker-compose.yml reads back-end/.env only when it exists, a setting older Compose versions reject.
• 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. Your app 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 or newer, the version every app declares in engines. The Docker images run on Node.js 24. Check yours with node -v.
• Yarn 4, through Corepack. Run corepack enable once; each app pins its own Yarn version in packageManager and ships its own yarn.lock, so yarn installs the exact tree the template was tested with. If your Node.js has no Corepack (Node.js 25 and newer leave it out), install it first with npm install -g corepack.
• No global packages.

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 SITE_PORT, ADMIN_PORT or API_PORT in a .env beside docker-compose.yml.

• A port is already in use

Port

The website listens on port 3030 and expects the API on 8000. Make sure nothing else uses them.

• A port is already in use

Port

The dashboard listens on port 3031 and expects the API on 8000. Make sure nothing else uses them.

• A port is already in use

Port

The API listens on port 8000, and by default accepts the website from 3030 and the dashboard from 3031. Make sure nothing else uses port 8000.

• A port is already in use

An API to connect

Your app has no data of its own. It needs the Hollina API running and seeded, whose address you set in its .env or pass as a build argument. The API is sold as its own package, the Backend API, and is part of the Full Stack.

• Connect your API

Optional services

None of these is needed to run the booking business locally. Each is switched on by its variables in the API's .env; a variable left commented out keeps its feature off.

There is no mail service to set up: the API sends no email. A guest sees what happened on the page they are on, and the host team is told in the dashboard's notifications.

• Configure these services
• Set up payments

Maps

The stay page draws its map of the approximate area with OpenFreeMap's Positron style, which needs an internet connection and no key or account. It promises no uptime, and NEXT_PUBLIC_MAP_STYLE_LIGHT and NEXT_PUBLIC_MAP_STYLE_DARK point the map at another MapLibre style.

• Map settings