Twenty

# MISSION: Scaffold "Twenty" 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 **Twenty**.
---
## 1. PROJECT SPECIFICATIONS & BENCHMARK
- **Reference Architecture**: Twenty
- **What It Does**: Modern open-source CRM alternative to Salesforce built with TypeScript, NestJS, React, GraphQL, and PostgreSQL.
- **Domain & Category**: CRM SaaS
- **Production Scale**: 6-20 people
- **Development Mode**: HYBRID
- **Architectural Rationale**: Twenty provides an extensible, modern CRM architecture featuring metadata-driven custom objects, GraphQL APIs, and clean UI design.
- **Live Website Reference**: https://twenty.com
- **Source Repository**: https://github.com/twentyhq/twenty
---
## 2. PRODUCTION TECH STACK
- **Full Stack Array**: TypeScript, React, NestJS, PostgreSQL, ClickHouse, Redis, GraphQL, Docker
- **Primary Language(s)**: TypeScript, MDX, JavaScript, Python, CSS, SCSS
- **License of the reference repo**: NOASSERTION
- **Frontend**: React — Single-page application rendering customer views, pipeline boards, and table grids
- **Backend & APIs**: TypeScript — Primary codebase language shared across server, front, UI, and SDK packages; NestJS — Modular backend framework organizing CRM business logic, auth, and worker queues; GraphQL — Primary client-server API layer powered by GraphQL Yoga and Apollo Client
- **Data & persistence**: PostgreSQL — Relational system storage for workspace schemas, custom objects, and core CRM records; ClickHouse — Columnar data store for analytics, event telemetry, and timeline audit logs; Redis — In-memory cache, pub/sub broker for GraphQL subscriptions, and BullMQ queues
- **Infrastructure & deploy**: Docker — Production container images and Postgres Spilo clustering setups
---
## 3. KEY ARCHITECTURAL DECISIONS (audited from https://github.com/twentyhq/twenty @ 2692a40)
1. **Dynamic Metadata-Driven Object Architecture**: Stores user-defined custom objects and fields as runtime metadata in PostgreSQL, synthesizing typed GraphQL schemas and database tables dynamically.
2. **Dual-Database Persistence with PostgreSQL and ClickHouse**: Uses PostgreSQL for transactional CRM entities while streaming timeline events, activity logs, and analytics metrics to ClickHouse.
3. **GraphQL Yoga and Apollo Client Communication**: Standardizes frontend data fetching on GraphQL with live SSE subscriptions, replacing traditional REST endpoint proliferation.
4. **Nx Workspace and Yarn Berry Monorepo**: Manages twenty-front, twenty-server, twenty-ui, and twenty-sdk in a unified monorepo with strict module boundaries and Oxlint caching.
---
## 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 (PostgreSQL, ClickHouse, Redis): 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.