Novu

# MISSION: Scaffold "Novu" 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 **Novu**.
---
## 1. PROJECT SPECIFICATIONS & BENCHMARK
- **Reference Architecture**: Novu
- **What It Does**: Novu is an open-source notification and agent-communication infrastructure platform built as a TypeScript Nx monorepo, with independent NestJS services for its API, worker, websocket, webhook, and inbound-mail apps backed by MongoDB and a BullMQ-based job queue.
- **Domain & Category**: Notification Infra
- **Production Scale**: 6-20 people
- **Development Mode**: HYBRID
- **Architectural Rationale**: Delivery concerns are split into separately deployable NestJS services (api, worker, ws, webhook, inbound-mail) sharing one Mongoose-based data-access library, so notification ingestion, queued processing, and realtime delivery can each be scaled and released on their own schedule inside a single Nx-managed workspace.
- **Live Website Reference**: https://novu.co
- **Source Repository**: https://github.com/novuhq/novu
---
## 2. PRODUCTION TECH STACK
- **Full Stack Array**: TypeScript, React, NestJS, MongoDB, Redis, BullMQ, Socket.IO, Nx, Docker
- **Primary Language(s)**: TypeScript, JavaScript, Python
- **License of the reference repo**: NOASSERTION
- **Frontend**: React — Builds the dashboard app with Vite.; Vite — Bundles and serves the dashboard application.
- **Backend & APIs**: NestJS — Implements the api, worker, ws, webhook, and inbound-mail services as separate NestJS apps.; Socket.IO — Powers the ws app, which pushes realtime in-app notifications to connected clients.
- **Data & persistence**: MongoDB — Primary datastore, accessed through Mongoose models in the shared dal library.; Redis — Backs the queue adapter used between the api, worker, and ws services.; BullMQ — Job queue for workflow execution, referenced via the BullMQ Pro fork installed at Docker build time.
- **Infrastructure & deploy**: Nx — Orchestrates builds and task dependencies across the apps/ and libs/ workspace.; Docker — Each service (api, worker, ws, webhook, inbound-mail) has its own multi-stage Dockerfile.; pnpm — Package manager for the Nx workspace.
- **Tooling, testing & ops**: LangChain — Used by the dashboard for LangGraph-based agent chat features.
---
## 3. KEY ARCHITECTURAL DECISIONS (audited from https://github.com/novuhq/novu @ a0b5e2d)
1. **Each runtime concern is a separate NestJS application under apps/**: apps/api, apps/worker, apps/ws, apps/webhook, and apps/inbound-mail each have their own package.json and Dockerfile (for example apps/worker/package.json and apps/ws/package.json), so the REST API, job processing, websocket delivery, inbound webhooks, and inbound email parsing scale and deploy independently.
2. **MongoDB access is centralized in a shared dal library**: libs/dal/package.json depends on mongoose and mongoose-delete and is consumed as a workspace package (@novu/dal) by apps/worker, apps/ws, and apps/webhook, so schema and query logic for MongoDB lives in one place instead of being duplicated per service.
3. **Enterprise queueing uses a private BullMQ Pro fork installed at build time**: apps/api/Dockerfile conditionally installs @taskforcesh/bullmq-pro during the Docker deploy stage when a BULL_MQ_PRO_NPM_TOKEN secret is present, layering the paid BullMQ Pro package on top of the open-source build rather than requiring it as a hard dependency.
4. **The dashboard is a standalone Vite/React app, not server-rendered**: apps/dashboard/package.json builds with vite build and serves static output via http-server for the start:static:build script, and end-to-end tests run against it with Playwright (test:e2e in the same file).
5. **Nx task graph replaces per-package build scripts for cross-cutting tasks**: The root package.json defines nx build @novu/api-service, nx run-many --target=build --all --projects=tag:type:package, and similar Nx-driven commands, with nx.json (trimmed in the audited facts but present at the repository root) configuring the project graph and task caching.
6. **Agent-facing surfaces get a dedicated workspace area**: The repository root contains libs/agent-evals and packages/agent-toolkit and packages/agent-event-protocol directories alongside the notification-delivery apps, and apps/dashboard/package.json depends on @langchain/langgraph-sdk and @assistant-ui/react for in-product agent chat.
---
## 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 (MongoDB, Redis, BullMQ): 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.