ABP Cursor Rules

A collection of Cursor.ai rules designed to enhance productivity when working with ABP Framework projects. These rules help streamline development workflows and provide intelligent assistance for ABP-specific patterns and practices.

⚠️ Project Status

This is a new, experimental project that is currently in its early stages. The rules have been created using AI and extensive documentation research, but they haven't been fully tested in major ABP projects yet. This repository serves as a starting point, and we hope that the community will help enhance and improve these rules over time through real-world usage and contributions.

Current Limitations

Currently, the rules primarily focus on MVC Razor Pages as the UI platform. We welcome contributions for other UI platforms. If you're working with any of these platforms, your contributions would be greatly appreciated to expand the rules' coverage.

🚀 Features

• ABP Framework-specific code generation templates
• Intelligent code completion for ABP patterns
• Best practices enforcement
• Domain-driven design (DDD) pattern suggestions
• Entity and aggregate root templates
• Repository pattern implementations
• Application service patterns
• ABP module configuration assistance

📋 Prerequisites

• Cursor IDE installed
• Basic understanding of ABP Framework
• Familiarity with C# and .NET development

🛠️ Installation

1. Clone this repository:

git clone https://github.com/yourusername/abp-cursor-rules.git

2. Copy the ABP rules to your Cursor rules directory:

cp -r abp-*/ ~/.cursor/rules/

3. Restart Cursor IDE to apply the new rules

💡 Usage

The rules will automatically activate when working with ABP Framework projects. They provide:

• Intelligent code suggestions
• Template-based code generation
• Pattern recognition and enforcement
• Best practice recommendations

🤝 Contributing

We welcome contributions to improve these rules! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contribution Guidelines

• Ensure your rules follow ABP Framework best practices
• Include clear documentation for new rules
• Add examples where appropriate
• Test your rules thoroughly before submitting
• Follow the existing code style and formatting

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• ABP Framework team for their excellent documentation
• Cursor.ai team for their amazing IDE
• All contributors who help improve these rules

📫 Contact

If you have any questions or suggestions, please open an issue in the repository.

---

Made with ❤️ by the ABP community