Better cursor rules (twentyhq#10431)

Move to the new cursor rule folder style and make it more granular

Author: FelixMalfait

.cursor/rules/README.md

@@ -0,0 +1,65 @@
+# Twenty Development Rules
+
+This directory contains Twenty's development guidelines and best practices. The rules are organized into several key categories:
+
+## Guidelines Structure
+
+### 1. Architecture and Structure
+- `architecture.md`: Project overview, technology stack, and infrastructure setup
+- `file-structure-guidelines.md`: File and directory organization patterns
+
+### 2. Code Style and Development
+- `typescript-guidelines.md`: TypeScript best practices and conventions
+- `code-style-guidelines.md`: General coding standards and style guide
+
+### 3. React Development
+- `react-general-guidelines.md`: Core React development principles and patterns
+- `react-state-management-guidelines.md`: State management approaches and best practices
+
+### 4. Testing
+- `testing-guidelines.md`: Testing strategies, patterns, and best practices
+
+### 5. Internationalization
+- `translations.md`: Translation workflow, i18n setup, and string management
+
+## Common Development Commands
+
+### Frontend Commands
+```bash
+# Testing
+npx nx test twenty-front                    # Run unit tests
+npx nx storybook:build twenty-front         # Build Storybook
+npx nx storybook:serve-and-test:static     # Run Storybook tests
+
+# Development
+npx nx lint twenty-front                    # Run linter
+npx nx typecheck twenty-front               # Type checking
+npx nx run twenty-front:graphql:generate    # Generate GraphQL types
+```
+
+### Backend Commands
+```bash
+# Database
+npx nx database:reset twenty-server         # Reset database
+npx nx run twenty-server:database:init:prod # Initialize database
+npx nx run twenty-server:database:migrate:prod # Run migrations
+
+# Development
+npx nx run twenty-server:start             # Start the server
+npx nx run twenty-server:lint              # Run linter (add --fix to auto-fix)
+npx nx run twenty-server:typecheck         # Type checking
+npx nx run twenty-server:test              # Run unit tests
+npx nx run twenty-server:test:integration:with-db-reset # Run integration tests
+
+# Migrations
+npx nx run twenty-server:typeorm migration:generate src/database/typeorm/metadata/migrations/[name] -d src/database/typeorm/metadata/metadata.datasource.ts
+
+# Workspace
+npx nx run twenty-server:command workspace:sync-metadata -f  # Sync metadata
+```
+
+## Usage
+
+These rules are automatically attached to relevant files in your workspace through Cursor's context system. They help maintain consistency and quality across the Twenty codebase.
+
+For the most up-to-date version of these guidelines, always refer to the files in this directory. 

.cursor/rules/architecture.md

@@ -0,0 +1,97 @@
+# Twenty Project Architecture
+
+## Overview
+Twenty is an open-source CRM built with modern technologies, using TypeScript for both frontend and backend development. This document outlines the core architectural decisions and structure of the project.
+
+## Monorepo Structure
+The project is organized as a monorepo using nx, with the following main packages:
+
+### Main Packages
+- `packages/twenty-front`: Main Frontend application
+  - Technology: React
+  - Purpose: Provides the main user interface for the CRM
+  - Key responsibilities: User interactions, state management, data display
+
+- `packages/twenty-server`: Main Backend application
+  - Technology: NestJS
+  - Purpose: Handles business logic, data persistence, and API
+  - Key responsibilities: Data processing, authentication, API endpoints
+
+- `packages/twenty-website`: Marketing Website and Documentation
+  - Technology: NextJS
+  - Purpose: Public-facing website and documentation
+  - Key responsibilities: Marketing content, documentation, SEO
+
+- `packages/twenty-ui`: UI Component Library
+  - Technology: React
+  - Purpose: Shared UI components and design system
+  - Key responsibilities: Reusable components, design consistency
+
+- `packages/twenty-shared`: Shared Utilities
+  - Purpose: Cross-package shared code between frontend and backend
+  - Contents: Utils, constants, types, interfaces
+
+## Core Technology Stack
+
+### Package Management
+- Package Manager: yarn
+- Monorepo Tool: nx
+- Benefits: Consistent dependency management, shared configurations
+
+### Database Layer
+- Primary Database: PostgreSQL
+- Schema Structure:
+  - Core schema: Main application data
+  - Metadata schema: Configuration and customization data
+  - Workspace schemas: One schema per tenant, containing tenant-specific data
+- ORM Layer:
+  - TypeORM: For core and metadata schemas
+    - Purpose: Type-safe database operations for system data
+    - Benefits: Strong typing, migration support
+  - TwentyORM: For workspace schemas
+    - Purpose: Manages tenant-specific entities and customizations
+    - Benefits: Dynamic entity management, per-tenant customization
+    - Example: Entities like CompanyWorkspaceEntity are managed per workspace
+
+### State Management
+- Frontend State: Recoil
+  - Purpose: Global state management
+  - Use cases: User preferences, UI state, cached data
+
+### Data Layer
+- API Technology: GraphQL
+- Client: Apollo Client
+  - Purpose: Data fetching and caching
+  - Benefits: Type safety, efficient data loading
+
+### Infrastructure
+- Cache: Redis
+  - Purpose: High-performance caching layer
+  - Use cases: Session data, frequent queries
+
+- Authentication: JWT
+  - Purpose: Secure user authentication
+  - Implementation: Token-based auth flow
+
+- Queue System: BullMQ
+  - Purpose: Background job processing
+  - Use cases: Emails, exports, imports
+
+- Storage: S3/Local Filesystem
+  - Purpose: File storage and management
+  - Flexibility: Configurable for cloud or local storage
+
+### Testing Infrastructure
+- Backend Testing:
+  - Framework: Jest
+  - API Testing: Supertest
+  - Coverage: Unit tests, integration tests
+
+- Frontend Testing:
+  - Framework: Jest
+  - Component Testing: Storybook
+  - API Mocking: MSW (Mock Service Worker)
+
+- End-to-End Testing:
+  - Framework: Playwright
+  - Coverage: Critical user journeys