Skip to content

Klucherev/dataui-nestjs-crud

This branch is 2 commits ahead of, 53 commits behind gid-oss/dataui-nestjs-crud:master.

Folders and files

NameName
Last commit message
Last commit date
Jul 10, 2023
Jun 1, 2023
Jun 8, 2019
Mar 15, 2023
Feb 26, 2024
Apr 18, 2020
May 28, 2019
Nov 10, 2023
Jun 10, 2019
May 28, 2019
Jul 10, 2023
Nov 10, 2023
Nov 27, 2021
Nov 10, 2023
Jun 15, 2022
Nov 10, 2023
Jan 22, 2019
Jun 15, 2022
Jul 8, 2019
Nov 10, 2023

Repository files navigation

CRUD

for RESTful APIs built with NestJs

Built with ๐Ÿ’œ by @MichaelYali and Contributors
๐ŸŒŸ ๐Ÿ‘€ โšก ๐Ÿ’ฅ

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

CRUD usage

  • ๐Ÿ”Œ 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

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 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)
  • @dataui/crud-typeorm - TypeORM package which provides base TypeOrmCrudService with methods for CRUD database operations (docs)

Documentation

Build library and run tests

yarn install
yarn clean
yarn build
docker compose up -d
yarn test:coverage

Make 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 dataui yarn login)

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 contributed. [Contribute].

Organizations

Currently this project is supported by Get It Done

License

MIT

About

NestJs CRUD for RESTful APIs

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.3%
  • JavaScript 0.7%