b104fafa85
- Renamed auth-service to iam-service across various files for consistency. - Updated Dockerfiles, deployment configurations, and documentation to reflect the service name change. - Enhanced testing commands in documentation to point to the new iam-service. - Removed outdated auth-service files and configurations to streamline the project structure. - Improved bilingual documentation for clarity on the new service structure and usage.
7.6 KiB
Cursor Skills Documentation
EN: Comprehensive documentation for all Cursor AI skills used in the GoodGo Microservices Platform
VI: Tài liệu đầy đủ cho tất cả Cursor AI skills được sử dụng trong GoodGo Microservices Platform
Overview / Tổng Quan
EN: Cursor Skills are specialized knowledge modules that guide AI assistants in following project-specific patterns, standards, and best practices. This directory contains detailed documentation for each skill, including when to use them, key concepts, common patterns, and real-world examples from the codebase.
VI: Cursor Skills là các module kiến thức chuyên biệt hướng dẫn AI assistants tuân theo các patterns, tiêu chuẩn và best practices cụ thể của dự án. Thư mục này chứa tài liệu chi tiết cho từng skill, bao gồm khi nào sử dụng, khái niệm chính, các pattern thường dùng, và ví dụ thực tế từ codebase.
Available Skills / Các Skills Có Sẵn
The GoodGo platform includes 9 Cursor Skills organized by category:
API & Data Layer
API Design
EN: RESTful API design standards for GoodGo microservices. Use when creating new API endpoints, designing DTOs, implementing controllers, writing OpenAPI documentation, or standardizing API responses.
VI: Tiêu chuẩn thiết kế RESTful API cho GoodGo microservices. Sử dụng khi tạo API endpoints mới, thiết kế DTOs, implement controllers, viết OpenAPI documentation, hoặc chuẩn hóa API responses.
Database & Prisma
EN: Prisma ORM and database patterns for GoodGo microservices. Use when working with databases, creating Prisma schemas, writing migrations, implementing repositories, or optimizing queries.
VI: Prisma ORM và database patterns cho GoodGo microservices. Sử dụng khi làm việc với databases, tạo Prisma schemas, viết migrations, implement repositories, hoặc optimize queries.
Code Quality & Testing
Testing Patterns
EN: Testing best practices for GoodGo microservices. Use when writing unit tests, integration tests, E2E tests, setting up Jest, mocking dependencies, or debugging test failures.
VI: Best practices về testing cho GoodGo microservices. Sử dụng khi viết unit tests, integration tests, E2E tests, setup Jest, mocking dependencies, hoặc debug test failures.
Code Comments
EN: Add bilingual code comments in Vietnamese and English for better documentation. Use when adding comments to code, documenting functions/classes, or when user requests Vietnamese/English documentation.
VI: Thêm code comments song ngữ bằng tiếng Việt và tiếng Anh để tài liệu tốt hơn. Sử dụng khi thêm comments vào code, document functions/classes, hoặc khi user yêu cầu tài liệu tiếng Việt/Anh.
Infrastructure & Operations
Kubernetes Deployment
EN: Kubernetes deployment patterns for GoodGo microservices. Use when deploying to staging/production, creating K8s manifests, configuring HPA, setting up ingress, or troubleshooting K8s deployments.
VI: Kubernetes deployment patterns cho GoodGo microservices. Sử dụng khi deploy lên staging/production, tạo K8s manifests, config HPA, setup ingress, hoặc troubleshoot K8s deployments.
Observability & Monitoring
EN: Observability and monitoring patterns for GoodGo microservices. Use when adding metrics, implementing logging, setting up tracing, creating health checks, or debugging production issues.
VI: Observability và monitoring patterns cho GoodGo microservices. Sử dụng khi thêm metrics, implement logging, setup tracing, tạo health checks, hoặc debug production issues.
Standards & Security
Project Rules
EN: GoodGo Microservices Platform coding standards and architecture patterns. Use when working with services, apps, packages, or infrastructure.
VI: Tiêu chuẩn coding và architecture patterns của GoodGo Microservices Platform. Sử dụng khi làm việc với services, apps, packages, hoặc infrastructure.
Security
EN: Security best practices and patterns for GoodGo microservices platform. Use when implementing authentication, authorization, data protection, input validation, rate limiting, secrets management, or security testing across all services.
VI: Security best practices và patterns cho GoodGo microservices platform. Sử dụng khi implement authentication, authorization, data protection, input validation, rate limiting, secrets management, hoặc security testing trên tất cả services.
Documentation
EN: Guidelines for writing technical documentation in the GoodGo project. Use when creating or updating README files, guides, architecture docs, or API documentation. Ensures bilingual (EN/VI) consistency and proper structure.
VI: Hướng dẫn viết technical documentation trong dự án GoodGo. Sử dụng khi tạo hoặc cập nhật README files, guides, architecture docs, hoặc API documentation. Đảm bảo tính nhất quán song ngữ (EN/VI) và cấu trúc phù hợp.
Quick Reference / Tham Khảo Nhanh
By Use Case / Theo Use Case
| Task | Recommended Skills |
|---|---|
| Creating a new API endpoint | API Design, Security, Testing Patterns |
| Setting up a new service | Project Rules, Database & Prisma, Observability |
| Writing tests | Testing Patterns, Comment Code |
| Deploying to production | Kubernetes Deployment, Observability, Security |
| Debugging production issues | Observability & Monitoring, Security |
| Writing documentation | Documentation, Comment Code |
| Implementing authentication | Security, API Design, Database & Prisma |
| Optimizing database queries | Database & Prisma, Observability |
Skill Dependencies / Phụ Thuộc Giữa Các Skills
Project Rules (Foundation)
├── API Design
├── Database & Prisma
├── Security
└── Testing Patterns
└── Comment Code
Documentation (Cross-cutting)
└── All skills
Observability (Cross-cutting)
└── All services
Kubernetes Deployment (Infrastructure)
└── All services
How to Use Skills / Cách Sử Dụng Skills
- When starting a new task: Review relevant skills in this directory
- During development: Reference skill documentation for patterns and examples
- When stuck: Check skill docs for best practices and common solutions
- For code review: Use skills as checklist for standards compliance
Related Documentation / Tài Liệu Liên Quan
- Architecture Overview - System design patterns
- Development Guide - Development workflow
- Deployment Guide - Deployment procedures
- API Documentation - OpenAPI specifications
Contributing / Đóng Góp
When updating or adding new skills:
- Update the skill source file in
.cursor/skills/{skill-name}/SKILL.md - Update the corresponding documentation in
docs/en/skills/{skill-name}.md - Update the Vietnamese translation in
docs/vi/skills/{skill-name}.md - Update this index file with any changes
- Ensure bilingual consistency
Resources / Tài Nguyên
- Cursor Skills Documentation - Official Cursor documentation
- Cursor AI - Cursor IDE homepage
- Project Skills:
.cursor/skills/- Source skill files