Introduction
Welcome to the MBC CQRS Serverless framework documentation!
What is MBC CQRS Serverless framework?
This framework provides core functionalities for implementing the Command Query Responsibility Segregation (CQRS) pattern within AWS serverless architectures, powered by the incredible NestJS framework. It simplifies the development of highly scalable and decoupled systems that can handle complex business logic and high-volume data processing.
Main features
| features | Description |
|---|---|
| CQRS framework for AWS serverless | - Structured approach for separating commands and queries. - Integration with AWS services like Cognito, API Gateway, Lambda, DynamoDB, SNS, and SQS, Step Functions, RDS ⚡ |
| Event-driven architecture | - Leverages Event Sourcing and messaging for asynchronous communication - Enables loose coupling and independent scaling of components |
| Command and query handlers | - Provides abstractions for handling commands and queries - Facilitates business logic implementation and data persistence |
| Asynchronous communication | - Supports event publishing and message passing for inter-component communication |
| Data consistency and integrity | - Ensures data consistency through Event Sourcing and optimistic locking - Enforces data integrity with validation and constraints |
| Experience a harmonious symphony of CQRS and NestJS | - Modular structure: Organize CQRS components with NestJS's elegant modularity. - Dependency injection: Simplify dependency management and embrace loose coupling with NestJS's DI system - TypeScript support: Write type-safe, crystal-clear code with built-in TypeScript - Testing and error handling: Build confidence with comprehensive testing and robust error handling, courtesy of NestJS - Ecosystem compatibility: Tap into the vast NestJS universe of modules and libraries to expand possibilities |
| Local Development | - Embrace agility: Experience rapid iteration and experimentation in a local environment, without the need for constant cloud deployment. - Debugging bliss: Debug with ease using your favorite tools and techniques, gaining deeper insights into your application's behavior. - Cost-effective exploration: Explore and refine your CQRS implementation locally, without incurring AWS costs during development. |
How to Use These Docs
On the left side of the screen, you'll find the docs navbar. The pages of the docs are organized sequentially, you can follow them step-by-step when building your application. However, you can read them in any order or skip to the pages that apply to your case.
On the right side of the screen, you'll see a table of contents that makes it easier to navigate between sections of a page. If you need to quickly find a page, you can use the search bar at the top, or the search shortcut (Ctrl+K or Cmd+K).
To get started, check out the Installation guide.
Recommended Learning Path
If you're new to the framework, follow this sequence:
| Step | Page | What you'll learn |
|---|---|---|
| 1 | Installation | Set up your local development environment |
| 2 | Quickstart Tutorial | Build a working API in 15 minutes |
| 3 | Project Structure | Understand the generated file layout |
| 4 | Architecture | CQRS and Event Sourcing concepts |
| 5 | Backend Development | Implement features with the CQRS pattern |
| 6 | Authentication | Role-based access control and group-based authorization |
| 7 | Examples | E-commerce · SaaS |
Related Documentation
- Installation - System requirements and setup instructions
- Quickstart Tutorial - Build your first API in 15 minutes
- Project Structure - Understanding the generated project layout
- Architecture - CQRS and Event Sourcing concepts
- Building Your Application - Application development guides and patterns
- Glossary - Framework terminology and key concepts
- Changelog - Release history and version notes
- AI Integration - AI development tool support with llms.txt and MCP
- Examples - Practical implementation examples and use cases
- API Reference - Complete module API reference