56 lines
1.8 KiB
Plaintext
56 lines
1.8 KiB
Plaintext
---
|
|
description: Project structure and file organization standards
|
|
globs: ["**/*"]
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Project Structure Standards
|
|
|
|
When working with any files, follow these structure standards:
|
|
|
|
## Project Structure Reference
|
|
Follow the complete project structure defined in @docs/structure.txt
|
|
|
|
## Documentation Structure
|
|
- **Main README**: @README.md
|
|
- **Project Structure**: @docs/structure.txt
|
|
- **Progress Tracking**: @docs/progress.md
|
|
- **Clean Code Guide**: @CLEAN_CODE.md
|
|
|
|
## Service Structure
|
|
Each service MUST follow the structure defined in @docs/structure.txt:
|
|
- **API Gateway**: @services/api-gateway/ with README.md and CLEAN_CODE.md
|
|
- **Service Adapters**: @services/service-adapters/ with README.md and CLEAN_CODE.md
|
|
- **API Docs**: @services/api-docs/ with README.md and CLEAN_CODE.md
|
|
|
|
## Frontend Structure
|
|
Follow the structure defined in @frontend/README.md:
|
|
- **Components**: @frontend/src/components/
|
|
- **Hooks**: @frontend/src/hooks/
|
|
- **Services**: @frontend/src/services/
|
|
- **Utils**: @frontend/src/utils/
|
|
- **Constants**: @frontend/src/constants/
|
|
|
|
## File Naming Conventions
|
|
- **Service Files**: Follow language conventions (Java, Python, Node.js)
|
|
- **Frontend Files**: PascalCase components, camelCase functions
|
|
- **Documentation**: README.md, CLEAN_CODE.md, RESILIENCE.md
|
|
|
|
## Documentation Updates
|
|
- Update @docs/structure.txt when adding new files
|
|
- Update @docs/progress.md when completing tasks
|
|
- Update service READMEs when modifying functionality
|
|
- Keep all documentation current and comprehensive
|
|
|
|
## Configuration Files
|
|
- Use .env files for environment variables
|
|
- Provide .env.example templates
|
|
- Multi-stage Docker builds for production
|
|
- Development-specific Dockerfiles
|
|
|
|
## Quality Gates
|
|
- Code formatting and linting
|
|
- Type checking and test execution
|
|
- Code review approval
|
|
- Documentation updates
|
|
- Security scans |