Git Product home page Git Product logo

dataui-nestjs-crud's Introduction

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

dataui-nestjs-crud's People

Contributors

0xflotus avatar asheliahut avatar bashleigh avatar bestori avatar ckaeslin avatar darkein avatar davarga avatar debagger avatar diluka avatar dschoeni avatar duongleh avatar eugenio165 avatar frco9 avatar fwoelffel avatar greenkeeper[bot] avatar jdguzman avatar jdolieslager avatar joennlae avatar kamilmysliwiec avatar klalex avatar michaelyali avatar renovate-bot avatar rewiko avatar robotscribe avatar roland-chernov avatar samisammour avatar tbrannam avatar xtcry avatar yepes avatar zaro avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.