Developer How-To Guides

How-to guides are problem-oriented. Each one answers a specific question: "How do I...?" They assume you already have a working environment and know what you want to accomplish.

Deployment

• Self-Hosting with Docker — Deploy the full stack using Docker Compose

Backend

• Add a NestJS API Module — Scaffold a new feature module following the project conventions
• Run Database Migrations — Write and apply Prisma migrations
• Add a BullMQ Job — Create a new background job type

Frontend

• Add a Frontend View — Add a new Vue route and page component
• Regenerate the API Client — Re-generate the typed SDK after API changes

Desktop and mobile

• Build the Desktop Tray App — Run, check and package the Tauri tray app for macOS and Windows
• Build the Mobile App — Build the client for Capacitor and run it on iOS and Android; how native auth, Google sign-in and push work
• Sign and Release the Mobile App — Keystores, certificates, App Store Connect keys, the APNs / FCM / Google credentials, and the release workflows

Configuration

• Configure the Environment — Set up .env for local and production

Contribution

• Contributing — Branch naming, PR workflow, linting, and commit conventions