CRUD (@n4it/crud)

for RESTful APIs built with NestJs

_{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

• 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

Install

npm i @n4it/crud class-transformer class-validator

Packages

• @n4it/crud - core package which provides @Crud() decorator for endpoints generation, global configuration, validation, helper decorators (docs)
• @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)
• @n4it/crud-typeorm - TypeORM package which provides base TypeOrmCrudService with methods for CRUD database operations (docs)

Documentation

• General Information
• CRUD Controllers
• CRUD ORM Services
• Handling Requests

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].

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