This is Engineering 11's fork of the excellent @nestjsx/crud microframework, optimized for our ecosystem and enhanced with additional features. We believe that everyone working with NestJs and building RESTful services will find this CRUD microframework very useful.
This repository is a maintained fork of the original nestjsx/crud library, created to:
- Ensure compatibility with the Engineering 11 ecosystem
- Add features specific to our development needs
- Provide ongoing maintenance and updates
- Maintain backward compatibility with the original nestjsx/crud API
All credit for the original design and implementation goes to @MichaelYali and the original contributors.
-
🔌 Super easy to install and start using the full-featured controllers and services 👉
-
🐙 DB and service agnostic extendable CRUD controllers
-
🔎 Reach query parsing with filtering, pagination, sorting, relations, nested relations, cache, etc.
-
🔭 Framework agnostic package with query builder for a frontend usage
-
👾 Query, path params and DTOs validation included
-
🎬 Overriding controller methods with ease
-
🔧 Tiny config (including globally)
-
🎁 Additional helper decorators
-
✏️ Swagger documentation
- @engineering11/crud - core package which provides
@Crud()decorator for endpoints generation, global configuration, validation, helper decorators - @engineering11/crud-request - request builder/parser package which provides
RequestQueryBuilderclass for frontend usage andRequestQueryParserfor backend query/path params handling and validation - @engineering11/crud-typeorm - TypeORM package which provides base
TypeOrmCrudServicewith methods for CRUD database operations - @engineering11/crud-util - utility package with helper functions and shared utilities
This fork is based on the original nestjsx packages:
- Original @nestjsx/crud - Documentation
- Original @nestjsx/crud-request - Documentation
- Original @nestjsx/crud-typeorm - Documentation
For comprehensive documentation, please refer to the original nestjsx/crud documentation:
The API remains compatible with the original nestjsx/crud implementation.
This is an Engineering 11 maintained fork. For issues specific to this fork, please create an issue in this repository. For general usage questions and original functionality, please refer to the original nestjsx/crud repository.
This project exists thanks to all the people who contribute. [Contribute].
