Skip to content

README.md

Latest commit

ย 

History

History
242 lines (166 loc) ยท 8.52 KB

README.md

File metadata and controls

242 lines (166 loc) ยท 8.52 KB

Awesome Cursor Rules

Project Status Translation Progress GitHub Stars GitHub Forks License

๐Ÿ‡บ๐Ÿ‡ธ English | ๐Ÿ‡จ๐Ÿ‡ณ ไธญๆ–‡็‰ˆ

A curated collection of Cursor AI coding rules for modern development stacks ไธบไธญๆ–‡ๅผ€ๅ‘่€…ๆ‰“้€ ็š„ Cursor AI ็ผ–็จ‹่ง„ๅˆ™้›†ๅˆ - ๆŸฅ็œ‹ไธญๆ–‡็‰ˆ

119 rule files ยท 43 tech domains ยท 568 technical docs

Quick Start ยท Browse Rules ยท Usage Guide ยท Contributing

English

๐Ÿ“– What is this?

Awesome Cursor Rules is a curated collection of Cursor AI coding assistant rules. This project provides comprehensive translations and localized content for global developers:

  • ๐ŸŽฏ Accurate Translation - High-quality translations with accurate technical terminology
  • ๐Ÿ“‚ Clear Structure - Organized by technology domain for easy discovery
  • ๐Ÿš€ Ready to Use - Copy .cursorrules file and start coding
  • ๐ŸŒ Bilingual Support - Complete English and Chinese documentation

๐Ÿ”ง What is .cursorrules?

.cursorrules is a project-level configuration file for the Cursor AI editor:

Feature Description Example
Coding Standards Define code style and naming conventions PascalCase components, camelCase functions
Tech Stack Specify frameworks, libraries, toolchains React + TypeScript + Tailwind
Best Practices Automatically apply industry standards Error handling, performance, security
AI Behavior Customize AI response and code generation style Detailed comments, functional programming

๐Ÿ’ก Essence: A "project handbook" for AI assistants

๐Ÿš€ Quick Start

Three Steps to Get Started

# 1. Clone the repository
git clone https://github.com/LessUp/awesome-cursorrules-zh.git

# 2. Browse available rules
cd awesome-cursorrules-zh
ls rules/frontend/react/  # View frontend React rules

# 3. Copy rules to your project
cp rules/frontend/react/nextjs-typescript/.cursorrules /path/to/your/project/

Popular Rules

Tech Stack Rule Path
Next.js + TypeScript nextjs-typescript rules/frontend/react/nextjs-typescript/
Vue 3 composition-api rules/frontend/vue/composition-api/
FastAPI fastapi-api-example rules/backend/python/fastapi-api-example/
Flutter flutter-app-expert rules/mobile/flutter/flutter-app-expert/
Go Backend backend-scalability rules/backend/go/backend-scalability/

๐Ÿ“– Complete Quick Start Guide ยท ไธญๆ–‡็‰ˆๅฟซ้€Ÿๅผ€ๅง‹

๐Ÿ“‚ Rule Categories

๐ŸŒ App Development
Domain Directory Includes
Frontend rules/frontend/ React, Vue, Angular, Svelte, TypeScript
Backend rules/backend/ Node.js, Python, Go, Java, PHP, .NET
Mobile rules/mobile/ Flutter, React Native, SwiftUI, Android
Database rules/database/ Cloud-native, Spatiotemporal
Systems rules/systems/ Modern C++ guidelines
๐Ÿค– AI & Data
Domain Directory Includes
AI/ML rules/ai/ Computer Vision, MLOps, Knowledge Graphs
Data Science rules/data-science/ Pandas, PyTorch, TensorFlow
Data Engineering rules/data/ Kafka, Spark, Data Warehouses
โ˜๏ธ Infrastructure
Domain Directory Includes
DevOps rules/devops/ Docker, K8s, Terraform, CI/CD
Cloud rules/cloud/ Middleware
Edge Computing rules/edge/ AI Inference, Model Compression
Security rules/security/ Zero Trust, Privacy Computing
๐Ÿ”ฌ Specialized Domains
Domain Directory Includes
Blockchain rules/blockchain/ Solidity, Web3, Smart Contracts
IoT rules/iot/ Embedded, Digital Twins
Quantum Computing rules/quantum/ Quantum Error Correction, Superconducting
Bio Tech rules/bio/ Bioelectronics, Biosensors

See full directory structure in rules/

๐Ÿ’ก Usage

Single Tech Stack Projects

# Copy relevant rules to project root
cp rules/frontend/react/nextjs-typescript/.cursorrules ./

Multi Tech Stack Projects

Option 1: Merge Rules

cat rules/frontend/react/nextjs-typescript/.cursorrules > .cursorrules
echo "" >> .cursorrules
cat rules/backend/python/fastapi-api-example/.cursorrules >> .cursorrules

Option 2: Directory-Level Rules (Recommended)

project/
โ”œโ”€โ”€ .cursorrules           # Global rules
โ”œโ”€โ”€ frontend/
โ”‚   โ””โ”€โ”€ .cursorrules       # Frontend-specific rules
โ””โ”€โ”€ backend/
    โ””โ”€โ”€ .cursorrules       # Backend-specific rules

Customizing Rules

# Append project-specific rules
cat >> .cursorrules << 'EOF'

## Project Custom Rules
- API routes use /api/v1 prefix
- All models must include created_at and updated_at fields
EOF

๐Ÿ“– Complete Best Practices Guide ยท ไธญๆ–‡็‰ˆๆœ€ไฝณๅฎž่ทต

๐Ÿ“Š Project Statistics

Metric Count
Rule Files 119 .cursorrules
Tech Domains 43 categories
Tech Documents 568 files
Translation Progress 100% complete
Documentation Languages English + Chinese

๐Ÿ“š Documentation

Document Description Link
Quick Start 5-minute getting started guide English ยท ไธญๆ–‡
Installation Guide Detailed setup instructions English ยท ไธญๆ–‡
Best Practices Configuration & usage tips English ยท ไธญๆ–‡
Troubleshooting Common issues & solutions English ยท ไธญๆ–‡
API Reference Rule format reference English ยท ไธญๆ–‡
Changelog Version history English ยท ไธญๆ–‡

๐Ÿค Contributing

Contributions are welcome in all forms:

  • ๐Ÿ› Report Issues โ€” Submit an Issue
  • ๐Ÿ”ง Improve Content โ€” Submit a Pull Request
  • ๐Ÿ”„ Sync Upstream โ€” Help keep this project in sync with the original
  • ๐Ÿ“ Enhance Documentation โ€” Improve guides and documentation

See Contributing Guide for details.

๐Ÿ“„ License

MIT License

๐Ÿ‡จ๐Ÿ‡ณ ไธญๆ–‡็‰ˆ

ๆœฌ้กน็›ฎๆไพ›ๅฎŒๆ•ด็š„ไธญๆ–‡ๆœฌๅœฐๅŒ–ๅ†…ๅฎน๏ผŒไธ“ไธบไธญๆ–‡ๅผ€ๅ‘่€…ไผ˜ๅŒ–ใ€‚่ฎฟ้—ฎ ไธญๆ–‡็‰ˆ README ๆŸฅ็œ‹ไธญๆ–‡็‰ˆๆœฌ็š„่ฏฆ็ป†่ฏดๆ˜Žใ€‚

Key features for Chinese developers:

  • ้ซ˜่ดจ้‡ไธญๆ–‡็ฟป่ฏ‘๏ผŒๆŠ€ๆœฏๆœฏ่ฏญๅ‡†็กฎ
  • ๆŒ‰ๆŠ€ๆœฏ้ข†ๅŸŸๅˆ†็ฑป๏ผŒไพฟไบŽๅฟซ้€ŸๆŸฅๆ‰พ
  • ๅผ€็ฎฑๅณ็”จ๏ผŒๅคๅˆถ .cursorrules ๆ–‡ไปถๅณๅฏไฝฟ็”จ
  • ๅฎŒๆ•ด็š„ไธญ่‹ฑๆ–‡ๅŒ่ฏญๆ–‡ๆกฃ

If this project helps you, please give it a โญ Star!

โฌ† Back to Top