Cursor rule

1---
2description: Guidelines for Project Structure
3globs: 
4alwaysApply: true
5---
6# Project Structure & Code Organization
7 
8## Package Manager
9- Use `pnpm` for all package installations and management
10 
11## Core Libraries and Versions
12- React: ^18.x.x
13- React DOM: ^18.x.x
14- TypeScript: ^5.x.x
15- Tailwind CSS: ^3.x.x
16- shadcn/ui: Latest components
17- Zod: ^3.x.x
18- TanStack Router: ^1.x.x
19- Tanstack Query: ^5.x.x
20- Zustand: ^4.x.x
21 
22## Naming Conventions
23- `kebab-case` - for all folders/files
24- `_kebab-case` - for feature domain's specific common modules
25- `-kebab-case` - for route domain's specific common modules
26- `PascalCase` - for classes and types
27- `snake_case` - for database tables and columns
28- `camelCase` - for functions, zod schemas and etc.
29 
30## Miscellaneous Folders
31- `docs` - for any to-do plan workflows or documentation
32- `prompts` - for prompts format
33- `rules` - for standards or rules of the repo
34- `.husky` - for husky configuration
35 
36## Common Modules
37- `assets` - for assets
38- `components` - for components
39- `constants` - for constants
40- `contexts` - for react context api
41- `data` - for data access layer (e.g. `api`, `database`)
42- `hooks` - for custom hooks, tanstack query and mutation
43- `lib` - for 3rd party integrations libraries
44- `services` - for business logic and orchestration of data access layer **(Only if necessary)**
45- `stores` - for stores (e.g. `zustand`)
46- `types` - for types
47- `utils` - for utilities
48  
49## Domain Folders
50- `src` - main source code and shared common modules
51- `src/routes` - main router folder
52- `src/features` - main features folder **(Only if necessary)**
53 
54## Shared Modules Structure
55Shared modules follow this structure:
56 
57```
58src/
59├── assets/                 # Shared assets module
60├── components/             # Shared dumb components module
61│   └── ui/                 # UI components (button, input, etc.)
62├── constants/              # Shared constants module
63├── contexts/               # Shared react context api module
64├── data/                   # Shared data access layer module (e.g. API functions, database)
65├── hooks/                  # Shared custom hooks, tanstack query and mutation
66│   ├── use-[custom].ts  # Shared custom hook
67│   └── query/              # TanStack Query hooks
68│       └── [entity]/  # TanStack Query entity folder
69│           ├── use-[entity]-query.ts     # Shared react-query query
70│           └── use-[entity]-mutation.ts  # Shared react-query mutation
71├── lib/                    # Shared 3rd party integrations
72├── services/               # Shared business logic
73├── stores/                 # Shared state stores (e.g. zustand)
74├── types/                  # Shared types
75└── utils/                  # Shared utilities
76```
77 
78## Routes Domain Structure - Default
79When creating new page/route files, follow this structure:
80 
81```
82src/routes/<route-name>/
83├── index.tsx               # Route's index page
84├── -components/            # Route's components
85├── -constants/             # Route's constants
86├── -contexts/              # Route's react context API
87├── -hooks/                 # Route's hooks
88├── -types/                 # Route's types
89└── -utils/                 # Route's utilities
90```
91 
92## Feature Domain Structure - Optional
93When creating new feature files, follow this structure:
94 
95```
96src/features/<feature-name>/
97├── _assets/                # Feature's assets
98├── _components/            # Feature's components
99├── _constants/             # Feature's constants
100├── _contexts/              # Feature's react context API
101├── _data/                  # Feature's data access layer
102├── _hooks/                 # Feature's custom hooks, tanstack query and mutation
103├── _lib/                   # Feature's 3rd party integrations
104├── _services/              # Feature's business logic
105├── _stores/                # Feature's state stores (e.g. zustand)
106├── _types/                 # Feature's types
107└── _utils/                 # Feature's utilities
108```
109