Skip to content

Installation

Local development

Clone the repository and install the JavaScript dependencies:

git clone https://github.com/leightonpayne/tiparo
cd tiparo
bun install

Start the app locally:

bun run dev

Start and make accessible over tailnet:

__VITE_ADDITIONAL_SERVER_ALLOWED_HOSTS=<MagicDNS> bun run dev --host

Docs toolchain

The docs site is built with Zensical and managed with uv:

uv sync
bun run docs:serve

Build commands

App only:

bun run build

Docs only:

bun run docs:build

That writes the docs output to dist/docs/.

Combined GitHub Pages artifact:

bun run pages:build

That command builds the app into dist/, then builds the docs directly into dist/docs/ so GitHub Pages can serve both from one deployment.

Use pages:build when you want the final deploy-shaped artifact. Running bun run build after bun run docs:build will rebuild dist/ for the app and remove the docs output until you build them again.