Gotify

# MISSION: Scaffold "Gotify" Production Architecture
You are an expert Senior Staff Software Architect and Full-Stack Engineer. Your mission is to scaffold and implement a production-grade, highly reliable, and modular codebase following the proven architecture of **Gotify**.
---
## 1. PROJECT SPECIFICATIONS & BENCHMARK
- **Reference Architecture**: Gotify
- **What It Does**: Gotify is a self-hosted, lightweight push-notification server: a Go REST and WebSocket backend paired with a React and TypeScript web UI, used to send and receive real-time messages from scripts, CI jobs and other services.
- **Domain & Category**: Self-Hosted Real-Time Push Server
- **Production Scale**: 2-5 People
- **Development Mode**: CLASSIC
- **Architectural Rationale**: Gotify keeps the server one deployable Go binary by embedding its Vite/React web UI, using Gin and gorilla/websocket for the REST and streaming API, and swapping SQLite, MySQL or PostgreSQL through GORM, while a compiled Go plugin system handles extensibility instead of a scripting layer.
- **Live Website Reference**: https://gotify.net
- **Source Repository**: https://github.com/gotify/server
---
## 2. PRODUCTION TECH STACK
- **Full Stack Array**: Go, TypeScript, React, Gin, GORM, WebSockets, SQLite, MySQL, PostgreSQL, Docker
- **Primary Language(s)**: Go, TypeScript
- **License of the reference repo**: NOASSERTION
- **Frontend**: React — Web UI (ui/) built with React 19 and TypeScript, compiled by Vite and served by the Go backend.; MobX — Client-side state management for the web UI (mobx, mobx-react-lite, mobx-utils).; Material UI — Component library for the web UI (@mui/material, @mui/icons-material) styled with Emotion.; Vite — Dev server, build and Vitest-based test runner for the ui/ package.
- **Backend & APIs**: Go — Entire server (REST API, WebSocket stream, auth, plugin host) is the Go module github.com/gotify/server/v3.; Gin — HTTP framework for the REST API, with gin-contrib/cors and gin-contrib/gzip middleware.; WebSockets — gorilla/websocket streams new messages to connected clients in real time via api/stream.; Zitadel OIDC — zitadel/oidc/v3 implements OpenID Connect login (api/oidc.go) alongside built-in username/password auth.
- **Data & persistence**: GORM — ORM abstracting the database layer; database/*.go implements applications, clients, messages and users on top of it.; SQLite — One of three GORM-driven database backends (gorm.io/driver/sqlite), commonly used for small self-hosted instances.; MySQL — Alternative GORM database backend (gorm.io/driver/mysql) for larger or shared deployments.; PostgreSQL — Alternative GORM database backend (gorm.io/driver/postgres).
- **Infrastructure & deploy**: Docker — Multi-stage build (docker/Dockerfile): node:24 compiles the UI, a gotify/build image compiles Go, debian runs the result.; GitHub Actions — build.yml is the CI workflow (referenced by the README build-status badge).
- **Tooling, testing & ops**: Vitest — Frontend unit tests for the ui/ package (yarn test / CI=true GOTIFY_EXE=... yarn test in the Makefile).; golangci-lint — Go linting configured via .golangci.yml, run through the Makefile check-go target.
---
## 3. KEY ARCHITECTURAL DECISIONS (audited from https://github.com/gotify/server @ e6361ca)
1. **Delivery is push over WebSocket, not polling, with a REST API alongside it**: api/stream implements a gorilla/websocket endpoint that pushes new messages to connected clients immediately, while api/message.go, api/application.go, api/client.go and api/user.go expose a conventional Gin-based REST API for everything else (creating apps, clients, managing messages).
2. **The database backend is swappable through GORM, not hard-coded**: go.mod pulls in gorm.io/driver/mysql, gorm.io/driver/postgres and gorm.io/driver/sqlite behind the shared gorm.io/gorm ORM, and database/database.go selects between them at startup, so a Gotify instance can run on an embedded SQLite file or a shared MySQL/PostgreSQL server without code changes.
3. **Extensibility is a compiled Go plugin system, not a scripting layer**: plugin/manager.go loads compiled Go plugins (.so files) at runtime against the gotify/plugin-api contract declared in go.mod, with plugin/example and plugin/compat covering the plugin API surface and cross-version compatibility, rather than embedding a scripting language like Lua or JavaScript for extensions.
4. **OIDC login sits next to built-in username/password auth**: api/oidc.go and go.mod's zitadel/oidc/v3 dependency add OpenID Connect login as an alternative to the default local-account flow implemented in auth/authentication.go and auth/token.go, letting self-hosters attach an existing identity provider without replacing the built-in auth.
5. **The web UI is a separate Vite/React app the Go binary serves, not server-rendered**: ui/package.json defines an independent Vite + React 19 + TypeScript single-page app (with its own vitest suite and ESLint config); ui/serve.go embeds the built assets into the Go binary so a Gotify deployment is still one process, and the Dockerfile's BUILD_JS argument controls whether that UI build runs as part of the image build.
6. **Docker images are cross-compiled for five architectures from one Makefile target**: The build-docker-multiarch target in the Makefile drives docker buildx build --platform linux/amd64,linux/arm64,linux/386,linux/arm/v7,linux/riscv64, tagging both gotify/server and ghcr.io/gotify/server per architecture, so the same Dockerfile produces images for common self-hosting targets including Raspberry Pi (arm) and RISC-V boards.
7. **Companion CLI and Android clients live outside this repository**: The README points to gotify/cli and gotify/android as separate repositories rather than folding them into this monorepo, keeping the server repository scoped to the API, WebSocket stream, web UI and plugin host.
---
## 4. NON-NEGOTIABLE ARCHITECTURAL GUARDRAILS
1. **Monorepo & Modular Separation**:
   - Structure as a Turborepo monorepo with strict package boundaries:
     - `apps/web`: Application UI, routing, layouts, and server endpoints.
     - `packages/ui`: Shared design tokens, CSS variables, and Radix UI primitive components.
     - `packages/db`: Database schemas, client singleton, declarative migrations, and seed scripts.
     - `packages/config`: Shared TypeScript, ESLint, and build configurations.
2. **Strict Type Safety & Zero `any` Policy**:
   - Enable `strict: true`, `noImplicitAny: true`, and `strictNullChecks: true`.
   - Validate ALL external inputs, API request bodies, and query parameters with **Zod** schemas before execution.
3. **Frontend & Rendering Guidelines**:
   - Isolate interactive UI state to leaf components. Keep core pages lightweight and performant.
4. **Design System & Aesthetics**:
   - Keep every color, radius, shadow and font in a single token file (CSS variables) and consume tokens everywhere; never hardcode hex values in components.
   - Prefer crisp 1px borders and one subtle shadow scale over blurry default shadows. Pair one sans-serif for body/headings with one monospace for tags, badges, metrics, and code.
5. **Data Layer & Reliability**:
   - Write declarative schema definitions with foreign keys, composite indexes on queried filters, and automated timestamp triggers.
   - Use connection pooling and prepared statements for serverless database execution.
---
## 5. STEP-BY-STEP SCAFFOLDING ROADMAP
- **Phase 1: Workspace & Root Config**: Initialize package manager, monorepo configuration (`turbo.json`, `tsconfig.base.json`, `package.json`).
- **Phase 2: Database Schema & Client**: Set up the data layer (GORM, SQLite, MySQL, PostgreSQL): client, connection pool, models, and migration scripts.
- **Phase 3: Design Tokens & UI Primitives**: Build accessible `Button`, `Input`, `Card`, `Badge`, and layout wrappers inside `packages/ui`.
- **Phase 4: Core Application Routes & Handlers**: Implement primary authentication, user session handling, and application routes.
- **Phase 5: Quality Assurance & Build Verification**: Run `tsc --noEmit`, ESLint, Prettier, and smoke test suites to ensure zero compilation or runtime errors.
---
## 6. EXECUTION INSTRUCTIONS
1. Review all specifications, architectural guardrails, and stack choices above.
2. Present the full monorepo directory tree structure.
3. Systematically generate the complete, production-ready codebase according to the 5-phase roadmap above — starting with the root workspace setup, followed by the database schema, UI design system package, and full-stack application routes until the repository is fully scaffolded and ready to run.