Run it on your computer

There are two ways to run YAPCO on your own computer:

	Docker	Node.js
You install	Only Docker	Node.js, Git and Google Chrome
Address	http://localhost:8080 (with /docs)	http://localhost:3000
Good for	Using YAPCO without changing your system	Changing the code; faster to update

Neither needs a server or an internet connection after the first start.

With Docker (recommended if you only use it)

Install Docker Desktop (Windows, macOS) or Docker Engine (Linux), then run the ready-made image:

docker run -d --name yapco --restart unless-stopped -p 127.0.0.1:8080:8080 --shm-size 1g --read-only --tmpfs /tmp --security-opt no-new-privileges ghcr.io/mdyzma/yapco:latest

The same command works in PowerShell, Terminal (macOS) and any Linux shell. (In Git Bash on Windows, put MSYS_NO_PATHCONV=1 before it, or Git Bash turns /tmp into a Windows path.) When it has downloaded, open http://localhost:8080. Updating, stopping it, other addresses, or building the image from the source yourself: Run with Docker.

With Node.js

Requirements

• Node.js 24 (nodejs.org; 22 or newer works)
• Git
• Google Chrome for PDF export (on Linux, Chromium works too)
• About 2 GB of disk space for the dependencies

Windows

Install Node.js from nodejs.org (the Windows installer), Git from git-scm.com and Google Chrome. Or with winget in PowerShell:

winget install OpenJS.NodeJS.LTS Git.Git Google.Chrome

Linux

Debian and Ubuntu (Node.js 24 from NodeSource; other distributions have similar packages):

curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
sudo apt-get install -y nodejs git chromium

macOS

With Homebrew:

brew install node@24 git
brew install --cask google-chrome

Install

Windows

In PowerShell:

cd ~
git clone https://github.com/mdyzma/yapco.git
cd yapco
corepack enable --install-directory "$env:APPDATA\npm" pnpm
pnpm install

Linux

cd ~
git clone https://github.com/mdyzma/yapco.git
cd yapco
sudo corepack enable
pnpm install

macOS

cd ~
git clone https://github.com/mdyzma/yapco.git
cd yapco
corepack enable
pnpm install

Check it worked: pnpm --version prints 12.x.

Start

pnpm dev

Wait for Ready and Export service on http://127.0.0.1:8787, then open http://localhost:3000. One command starts both the app and the PDF export service. To stop, press Ctrl+C.

On Linux with Chromium instead of Google Chrome, tell the export service where it is first:

export CHROME_PATH=/usr/bin/chromium
pnpm dev

Always use the same address

Planners are stored per browser and per address. http://127.0.0.1:3000, another browser, a private window, Docker on :8080 or a hosted site each have their own, separate, empty storage. Move planners between them with JSON files.

Update

With the app stopped:

git pull
pnpm install
pnpm dev

Your planners are not touched (they are in the browser, not in the project folder), but save JSON backups first anyway. If a page looks wrong after updating, reload it with Ctrl+F5 (Windows, Linux) or Cmd+Shift+R (macOS).

This documentation, locally

pnpm --filter @planner/docs dev

It opens on http://localhost:4321/docs/. Under pnpm dev the app’s Documentation link points to /docs, which only the Docker image and servers serve.

Check everything works (optional)

pnpm check

Lint, types, all unit tests and the build: the same as CI. See Troubleshooting if something fails.