Skip to Content
Z8Z8 Docs
Technical Docs

Getting Started

Prerequisites, development workflow, and code quality standards

Prerequisites

  • Bun runtime (recommended) or Node.js with pnpm.

Development Workflow

# Install dependencies
bun install

# Run all apps in development mode
bun dev

Infrastructure & Configuration

Authentication

Generate auth schema:

bunx --bun @better-auth/cli generate --output ./src/db/schema.ts

Generate auth secret:

bunx @better-auth/cli@latest secret

Push Notifications

Generate VAPID keys for push notifications:

bunx web-push generate-vapid-keys

Add these to your .env file:

VAPID_PUBLIC_KEY=<generated-public-key>
VAPID_PRIVATE_KEY=<generated-private-key>
VAPID_SUBJECT=mailto:support@yourdomain.com

Optional: native push for the iOS and Android store app goes through Firebase Cloud Messaging. Add a Firebase service account that may send Cloud Messaging messages:

FCM_PROJECT_ID=<firebase-project-id>
FCM_CLIENT_EMAIL=<service-account-client-email>
FCM_PRIVATE_KEY=<service-account-private-key>

Without these, native push is off and web push works as before. The app side is described in apps/mobile/README.md.


Code Quality Standards

This project follows strict quality standards enforced by Ultracite (Biome preset).

npx ultracite fix

Automatically format code and fix issues.

For more details, see the internal Ultracite Code Standards documentation.

On this page