Skip to content

brauerj-gc/abp-ai-rules

 
 

Repository files navigation

ABP Development Rules

A collection of development rules and specialized assistants designed to enhance productivity when working with ABP Framework projects. This repository provides intelligent assistance for ABP-specific patterns and practices, supporting both Cursor.ai and Claude Code development environments.

⚠️ 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 Coverage

The repository now includes comprehensive support for:

  • MVC Razor Pages: Complete UI development patterns
  • Blazor Server: Component architecture, real-time features, and forms
  • Angular: Frontend development with TypeScript, state management, and routing
  • Domain-Driven Design: Full DDD implementation guidance
  • Application Services: DTOs, validation, and business logic coordination
  • Authorization: Security and permission management

We welcome contributions for additional UI platforms like Blazor WebAssembly and React.

🚀 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

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

🛠️ Installation

For Claude Code

  1. Clone this repository:
git clone https://github.com/yourusername/abp-cursor-rules.git
  1. Copy the Claude Code agents to your project:
cp -r .claude/ /path/to/your/abp-project/
  1. The specialized ABP assistants will be available in your Claude Code environment

For Cursor.ai

  1. Clone this repository:
git clone https://github.com/yourusername/abp-cursor-rules.git
  1. Copy the ABP rules to your Cursor rules directory:
cp -r abp-*/ ~/.cursor/rules/
  1. Restart Cursor IDE to apply the new rules

💡 Usage

Claude Code Usage

Claude Code will automatically detect the specialized ABP assistants in your project's .claude/agents/ directory. These assistants provide:

  • ABP DDD General Assistant: Overall ABP and Domain-Driven Design guidance
  • ABP Domain Layer Assistant: Specialized help for domain model development
  • ABP Application Layer Assistant: Support for application services, DTOs, and mapping
  • ABP Authorization Assistant: Security and permission system implementation
  • ABP MVC Razor Assistant: UI development with Razor Pages and client-side integration
  • ABP Blazor Server Assistant: Component architecture, real-time features, and modern UI patterns
  • ABP Angular Assistant: Frontend development with TypeScript, reactive patterns, and ABP integration

Cursor.ai 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
  • Anthropic for Claude Code and the powerful AI assistance
  • 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

About

A set of Cursor.ai (and Claude Code) rules to enhance productivity with abp.io

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published