| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 23 | 8 | 0% |
| Commands | 0 | 0 | 0 | — |
| Section tags | 1 | 5 | 2 | 13% |
What each file covers
Sections
0 shared · 23 only in A · 8 only in B- − Twenty Development Rules
- − Rules Overview
- − Core Guidelines
- − Code Quality
- − React Development
- − Testing & Quality
- − Internationalization
- − How Rules Work
- − Automatic Attachment
- − Manual Reference
- − Rule Types Used
- − Development Commands
- − Frontend Commands
- − Backend Commands
- − Usage Guidelines
- − For Developers
- − For AI Assistants
- − Contributing to Rules
- − Adding New Rules
- − Updating Existing Rules
- − Rule Format Reference
- − Rule Title
- − Migration from Legacy Format
- + File Structure Guidelines
- + Directory Organization
- + File Naming
- + Index Files & Barrel Exports
- + File Size Guidelines
- + Configuration Files
- + Project Configuration
- + Build Configuration
Commands
neither file has anySection tags
1 shared · 5 only in A · 2 only in B- − test
- − lint-format
- − types
- − database
- − do-not
- + build
- + code-style
- architecture
Line diff
nowtec/nowCRM · .cursor/rules/readme.mdc
@@ −1 @@
1---
2description: NOWCRM development rules and best practices
3globs: []
4alwaysApply: true
5---
6# Twenty Development Rules
7
8This directory contains NOWCRM's development guidelines and best practices in the modern Cursor Rules format (MDC). These rules are automatically applied based on file patterns and provide context-aware guidance to AI assistants.
9
10## Rules Overview
11
12### Core Guidelines
13- **architecture.mdc** - Project overview, technology stack, and infrastructure setup (Always Applied)
14
15### Code Quality
16- **typescript-guidelines.mdc** - TypeScript best practices and conventions (Auto-attached to .ts/.tsx files)
17- **code-style.mdc** - General coding standards and style guide (Auto-attached to code files)
18- **file-structure.mdc** - File and directory organization patterns (Auto-attached to config files)
19
20### React Development
21- **react-general-guidelines.mdc** - Core React development principles (Auto-attached to React files)
22
23### Testing & Quality
24- **testing-guidelines.mdc** - Testing strategies and best practices (Auto-attached to test files)
25
26### Internationalization
27- **translations.mdc** - Translation workflow and i18n setup (Auto-attached to locale files)
28
29## How Rules Work
30
31### Automatic Attachment
32Rules are automatically included in your AI context based on file patterns (globs). When you work on TypeScript files, the TypeScript guidelines are automatically loaded.
33
34### Manual Reference
35You can manually reference any rule using the `@ruleName` syntax:
36- `@react-general-guidelines` - Load React best practices
37- `@testing-guidelines` - Get testing recommendations
38
39### Rule Types Used
40- **Always Applied** - Loaded in every context (architecture.mdc, README.mdc)
41- **Auto Attached** - Loaded when matching file patterns are referenced
42- **Agent Requested** - Available for AI to include when relevant
43- **Manual** - Only included when explicitly mentioned
44
45## Development Commands
46
47### Frontend Commands
48
49todo:
50
51### Backend Commands
52
53todo:
54
55## Usage Guidelines
56
57### For Developers
58- Rules are automatically applied based on file context
59- Check rule descriptions to understand when they're activated
60- Use manual references (`@ruleName`) for additional context
61- Keep rules updated as the codebase evolves
62
63### For AI Assistants
64- Rules provide consistent guidance across conversations
65- Use rule context to maintain coding standards
66- Reference specific rules when making recommendations
67- Apply rule principles in code suggestions and reviews
68
69## Contributing to Rules
70
71### Adding New Rules
721. Create a new `.mdc` file in this directory
732. Include proper metadata headers with description and globs
743. Write clear, actionable guidelines with examples
754. Test the rule with relevant file patterns
765. Update this README if needed
77
78### Updating Existing Rules
791. Modify the rule content while preserving metadata
802. Test changes with affected file patterns
813. Ensure consistency with other rules
824. Update examples and best practices as needed
83
84## Rule Format Reference
85
86Each rule file uses the MDC format with metadata:
87
88```markdown
89---
90description: Brief description of the rule's purpose
91globs: ["**/*.ts", "**/*.tsx"] # File patterns for auto-attachment
92alwaysApply: false # Whether to always include this rule
93---
94
95# Rule Title
96
97Rule content in Markdown format...
98```
99
100## Migration from Legacy Format
101
102The rules have been migrated from the legacy `.md` format to the modern `.mdc` format, providing:
103- Better context awareness through file pattern matching
104- Improved organization with metadata headers
105- More flexible rule application strategies
106- Enhanced integration with Cursor's AI features
107
108For the most up-to-date version of these guidelines, always refer to the files in this directory.
nowtec/nowCRM · .cursor/rules/file-structure.mdc
@@ +1 @@
1---
2description: File structure guidelines for NOWCRM
3globs: []
4alwaysApply: true
5---
6# File Structure Guidelines
7
8## Directory Organization
9```
10apps/nowcrm/
11├── components/ # Reusable UI components
12├── app/ # Route components
13├── i18n/ # I18N configuration
14├── lib/ # Handling server actions and different utils
15├── hooks/ # Custom hooks
16├── types/ # Type definitions
17└── messages/ # I18N jsons for each language
18
19apps/composer/src/
20├── api/ # Api routes
21├── api-docs/ # Handling api routes setup
22├── common/ # Common and reused utils
23├── lib/ # Functions, types and workers
24└── scheduler/ # Scheduler which are integrated with composer calendar
25
26apps/journeys/src/
27├── api/ # Handling webhooks api routes for journeys
28├── common/ # Common and reused utils
29├── consumers/ # All journeys consumers setup
30├── cron/ # Cron jobs which acts as a producer to create new jobs
31├── jobs/ # All job configuration
32├── lib/ # Functions, types and workers
33└── rabbitmq/ # Rabbitmq setup
34```
35
36## File Naming
37- **kebab-case** for all files and directories
38- **Descriptive suffixes** for clarity
39```
40// ✅ Correct naming
41user.tsx
42user.component.tsx
43user.service.ts
44user.test.tsx
45```
46
47## Index Files & Barrel Exports
48```typescript
49// ✅ Clean barrel exports in index.ts
50export { UserCard } from './user-card.component';
51export { UserList } from './user-list.component';
52export type { UserCardProps, UserListProps } from './types';
53
54// ✅ Usage - clean imports
55import { UserCard, UserList } from '@/components/user';
56```
57
58## File Size Guidelines
59- **Components**: Under 300 lines if possible
60- **Services**: Under 500 lines if possible
61- **Extract logic** into hooks/utilities when files grow large
62- **Use composition** over large monolithic components
63
64## Configuration Files
65
66### Project Configuration
67```
68.vscode/ # VSCode settings
69├── settings.json
70├── extensions.json
71└── launch.json
72
73.github/ # GitHub workflows
74├── workflows/
75└── templates/
76
77.cursor/ # Cursor rules
78├── rules/
79└── environment.json
80```
81
82### Build Configuration
83- Keep build configs in root or package directories
84- Use consistent naming for config files
85- Comment complex configurations
86- Version control all configuration files
@@ −1 +1 @@
11 ---
2−description: NOWCRM development rules and best practices
2+description: File structure guidelines for NOWCRM
33 globs: []
44 alwaysApply: true
55 ---
6−# Twenty Development Rules
6+# File Structure Guidelines
77
8−This directory contains NOWCRM's development guidelines and best practices in the modern Cursor Rules format (MDC). These rules are automatically applied based on file patterns and provide context-aware guidance to AI assistants.
8+## Directory Organization
9+```
10+apps/nowcrm/
11+├── components/ # Reusable UI components
12+├── app/ # Route components
13+├── i18n/ # I18N configuration
14+├── lib/ # Handling server actions and different utils
15+├── hooks/ # Custom hooks
16+├── types/ # Type definitions
17+└── messages/ # I18N jsons for each language
918
10−## Rules Overview
19+apps/composer/src/
20+├── api/ # Api routes
21+├── api-docs/ # Handling api routes setup
22+├── common/ # Common and reused utils
23+├── lib/ # Functions, types and workers
24+└── scheduler/ # Scheduler which are integrated with composer calendar
1125
12−### Core Guidelines
13−- **architecture.mdc** - Project overview, technology stack, and infrastructure setup (Always Applied)
26+apps/journeys/src/
27+├── api/ # Handling webhooks api routes for journeys
28+├── common/ # Common and reused utils
29+├── consumers/ # All journeys consumers setup
30+├── cron/ # Cron jobs which acts as a producer to create new jobs
31+├── jobs/ # All job configuration
32+├── lib/ # Functions, types and workers
33+└── rabbitmq/ # Rabbitmq setup
34+```
1435
15−### Code Quality
16−- **typescript-guidelines.mdc** - TypeScript best practices and conventions (Auto-attached to .ts/.tsx files)
17−- **code-style.mdc** - General coding standards and style guide (Auto-attached to code files)
18−- **file-structure.mdc** - File and directory organization patterns (Auto-attached to config files)
36+## File Naming
37+- **kebab-case** for all files and directories
38+- **Descriptive suffixes** for clarity
39+```
40+// ✅ Correct naming
41+user.tsx
42+user.component.tsx
43+user.service.ts
44+user.test.tsx
45+```
1946
20−### React Development
21−- **react-general-guidelines.mdc** - Core React development principles (Auto-attached to React files)
47+## Index Files & Barrel Exports
48+```typescript
49+// ✅ Clean barrel exports in index.ts
50+export { UserCard } from './user-card.component';
51+export { UserList } from './user-list.component';
52+export type { UserCardProps, UserListProps } from './types';
2253
23−### Testing & Quality
24−- **testing-guidelines.mdc** - Testing strategies and best practices (Auto-attached to test files)
54+// ✅ Usage - clean imports
55+import { UserCard, UserList } from '@/components/user';
56+```
2557
26−### Internationalization
27−- **translations.mdc** - Translation workflow and i18n setup (Auto-attached to locale files)
58+## File Size Guidelines
59+- **Components**: Under 300 lines if possible
60+- **Services**: Under 500 lines if possible
61+- **Extract logic** into hooks/utilities when files grow large
62+- **Use composition** over large monolithic components
2863
29−## How Rules Work
64+## Configuration Files
3065
31−### Automatic Attachment
32−Rules are automatically included in your AI context based on file patterns (globs). When you work on TypeScript files, the TypeScript guidelines are automatically loaded.
66+### Project Configuration
67+```
68+.vscode/ # VSCode settings
69+├── settings.json
70+├── extensions.json
71+└── launch.json
3372
34−### Manual Reference
35−You can manually reference any rule using the `@ruleName` syntax:
36−- `@react-general-guidelines` - Load React best practices
37−- `@testing-guidelines` - Get testing recommendations
73+.github/ # GitHub workflows
74+├── workflows/
75+└── templates/
3876
39−### Rule Types Used
40−- **Always Applied** - Loaded in every context (architecture.mdc, README.mdc)
41−- **Auto Attached** - Loaded when matching file patterns are referenced
42−- **Agent Requested** - Available for AI to include when relevant
43−- **Manual** - Only included when explicitly mentioned
44−
45−## Development Commands
46−
47−### Frontend Commands
48−
49−todo:
50−
51−### Backend Commands
52−
53−todo:
54−
55−## Usage Guidelines
56−
57−### For Developers
58−- Rules are automatically applied based on file context
59−- Check rule descriptions to understand when they're activated
60−- Use manual references (`@ruleName`) for additional context
61−- Keep rules updated as the codebase evolves
62−
63−### For AI Assistants
64−- Rules provide consistent guidance across conversations
65−- Use rule context to maintain coding standards
66−- Reference specific rules when making recommendations
67−- Apply rule principles in code suggestions and reviews
68−
69−## Contributing to Rules
70−
71−### Adding New Rules
72−1. Create a new `.mdc` file in this directory
73−2. Include proper metadata headers with description and globs
74−3. Write clear, actionable guidelines with examples
75−4. Test the rule with relevant file patterns
76−5. Update this README if needed
77−
78−### Updating Existing Rules
79−1. Modify the rule content while preserving metadata
80−2. Test changes with affected file patterns
81−3. Ensure consistency with other rules
82−4. Update examples and best practices as needed
83−
84−## Rule Format Reference
85−
86−Each rule file uses the MDC format with metadata:
87−
88−```markdown
89−---
90−description: Brief description of the rule's purpose
91−globs: ["**/*.ts", "**/*.tsx"] # File patterns for auto-attachment
92−alwaysApply: false # Whether to always include this rule
93−---
94−
95−# Rule Title
96−
97−Rule content in Markdown format...
77+.cursor/ # Cursor rules
78+├── rules/
79+└── environment.json
9880 ```
9981
100−## Migration from Legacy Format
101−
102−The rules have been migrated from the legacy `.md` format to the modern `.mdc` format, providing:
103−- Better context awareness through file pattern matching
104−- Improved organization with metadata headers
105−- More flexible rule application strategies
106−- Enhanced integration with Cursor's AI features
107−
108−For the most up-to-date version of these guidelines, always refer to the files in this directory.
82+### Build Configuration
83+- Keep build configs in root or package directories
84+- Use consistent naming for config files
85+- Comment complex configurations
86+- Version control all configuration files
