CRUD (@n4it/crud)

for RESTful APIs built with NestJs

Logo n4it

License npm version npm downloads Renovate PRs welcome
Built by @MichaelYali and n4it and Contributors

We believe that everyone who's working with NestJs and building some RESTful services and especially some CRUD functionality will find `@n4it/crud` microframework very useful. ## Features CRUD usage - Super easy to install and start using the full-featured controllers and services :point_right: - 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 ## Install ```shell npm i @n4it/crud class-transformer class-validator ``` ## Packages - [**@n4it/crud**](https://www.npmjs.com/package/@n4it/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs](https://gid-oss.github.io/dataui-nestjs-crud/controllers/#description)) - [**@n4it/crud-request**](https://www.npmjs.com/package/@n4it/crud-request) - request builder/parser package which provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internally for handling and validating query/path params on a backend side ([docs](https://gid-oss.github.io/dataui-nestjs-crud/requests/#frontend-usage)) - [**@n4it/crud-typeorm**](https://www.npmjs.com/package/@n4it/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs](https://gid-oss.github.io/dataui-nestjs-crud/service-typeorm/)) ## Documentation - [General Information](https://gid-oss.github.io/dataui-nestjs-crud/) - [CRUD Controllers](https://gid-oss.github.io/dataui-nestjs-crud/controllers/#description) - [CRUD ORM Services](https://gid-oss.github.io/dataui-nestjs-crud/services/) - [Handling Requests](https://gid-oss.github.io/dataui-nestjs-crud/requests/#description) ## Support Any support is welcome. At least you can give us a star. ## Contributors ### Code Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. ### Financial Contributors #### Organizations Currently this project is sponsored and maintained by N4IT. Get in touch if you want to become a sponsor. ## License [GPL-3.0](LICENSE)