@tlns/crud
v5.1.0
Published
Nest CRUD for RESTful APIs
Downloads
30
Readme
We believe that everyone who's working with NestJs and building some RESTful services and especially some CRUD functionality will find @dataui/crud microframework very useful.
Features
:electric_plug: Super easy to install and start using the full-featured controllers and services :point_right:
:octopus: DB and service agnostic extendable CRUD controllers
:mag_right: Reach query parsing with filtering, pagination, sorting, relations, nested relations, cache, etc.
:telescope: Framework agnostic package with query builder for a frontend usage
:space_invader: Query, path params and DTOs validation included
:clapper: Overriding controller methods with ease
:wrench: Tiny config (including globally)
:gift: Additional helper decorators
:pencil2: Swagger documentation
Install
yarn add @dataui/crud-typeorm
Packages
- @dataui/crud - core package which provides
@Crud()decorator for endpoints generation, global configuration, validation, helper decorators (docs) - @dataui/crud-request - request builder/parser package which provides
RequestQueryBuilderclass for a frontend usage andRequestQueryParserthat is being used internally for handling and validating query/path params on a backend side (docs) - @dataui/crud-typeorm - TypeORM package which provides base
TypeOrmCrudServicewith methods for CRUD database operations (docs)
Documentation
- :dart: General Information
- :video_game: CRUD Controllers
- :horse_racing: CRUD ORM Services
- :trumpet: Handling Requests
Build library and run tests
yarn install
yarn clean
yarn build
docker compose up -d
yarn test:coverageMake a release
- Merge a PR on master.
- Pull and checkout master
- Update Changelog and commit
- Run tests
yarn clean && yarn build && docker-compose up -d && yarn test:coverage - Run
yarn pub- this will publish on the npm repo (need to be logged under datauiyarn login)
Support
Any support is welcome. At least you can give us a star :star:
Contributors
Code Contributors
This project exists thanks to all the people who contributed. [Contribute].
Organizations
Currently this project is supported by Get It Done
