aurora-cqrs

Explain CQRS architecture and component interactions in Aurora/NestJS projects.

Updated Jan 26, 2023
One-click install
npx skills add https://github.com/avvale/aurora-back --skill aurora-cqrs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aurora-cqrs
Source: https://github.com/avvale/aurora-back/tree/main/.claude/skills/aurora-cqrs
Command: npx skills add https://github.com/avvale/aurora-back --skill aurora-cqrs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill clarifies the complex Command Query Responsibility Segregation (CQRS) architecture used in Aurora/NestJS projects, making it easier to understand component interactions and where to implement code.

Core Features & Use Cases

  • CQRS Architecture Explanation: Details Commands, Queries, Handlers, Events, and Sagas.
  • Component Relationships: Visualizes the flow between layers (@api, @app/application, @app/domain, @app/infrastructure).
  • Editable Zones Identification: Clearly marks which parts of generated files are safe to modify.
  • Use Case: When you receive a new Aurora project or need to onboard a new developer, use this Skill to quickly grasp the CQRS pattern and the project's structure.

Quick Start

Explain the role of @api handlers in the Aurora CQRS architecture.

Frequently Asked Questions about aurora-cqrs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How does CQRS architecture work in NestJS projects?

CQRS architecture in NestJS separates read and write operations into distinct components: Commands for mutations, Queries for data retrieval, Events for asynchronous actions, and Sagas for complex process orchestration. This Skill details how these handlers interact across application, domain, and infrastructure layers.

What is the role of API handlers in Aurora CQRS architecture?

API handlers in Aurora CQRS act as entry points that route incoming requests to specific Commands or Queries. They interface with the application layer to dispatch operations to appropriate handlers, ensuring clean separation between request orchestration and business logic execution.

How do I onboard a new developer to an Aurora NestJS codebase?

To onboard a new developer to an Aurora NestJS codebase, use this Skill to explain the CQRS pattern and project structure. It clarifies component relationships, data flow across layers, and identifies editable zones in generated files to prevent accidental overwrites.

Where are the editable zones in Aurora generated files?

Editable zones in Aurora generated files are clearly marked sections where developers can safely add custom logic without risking overwrites during regeneration. This Skill identifies these boundaries to help you understand where to implement commands, queries, events, and sagas.

When should I use sagas in a CQRS pattern?

Sagas in the CQRS pattern manage long-running transactions and coordinate multiple events. Within Aurora/NestJS, sagas listen to domain events and trigger subsequent commands, making them essential for complex business processes that require multi-step orchestration.

Can I modify generated CQRS files in an Aurora project safely?

Yes, you can modify generated CQRS files in an Aurora project safely by editing within designated editable zones. This Skill clarifies these boundaries, ensuring your custom command, query, and event implementations remain intact during code generation cycles.