https://github.com/nestjsx/crud

NestJs CRUD for RESTful APIs
https://github.com/nestjsx/crud

crud crud-generator nest nestjs restful-api typeorm typescript

Last synced: 26 days ago
JSON representation

NestJs CRUD for RESTful APIs

• Host: GitHub
• URL: https://github.com/nestjsx/crud
• Owner: nestjsx
• License: mit
• Created: 2018-05-18T20:03:38.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T16:16:04.000Z (7 months ago)
• Last Synced: 2024-04-14T01:02:19.547Z (7 months ago)
• Topics: crud, crud-generator, nest, nestjs, restful-api, typeorm, typescript
• Language: TypeScript
• Homepage: https://github.com/nestjsx/crud/wiki
• Size: 2.32 MB
• Stars: 3,908
• Watchers: 60
• Forks: 508
• Open Issues: 289
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome - nestjsx/crud - NestJs CRUD for RESTful APIs (TypeScript)
• awesome-rest - Nestjsx/crud - Generate CRUD controllers and services for RESTful API with NestJS and TypeORM. (Servers / Node.js)
• awesome-nestjs - Nest CRUD - 用于 RESTful API 的 Nest CRUD。 (资源 / 组件和库)
• awesome-list - crud
• made-in-ukraine - nestjsx/crud

README

        
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine/)



  
:point_right:You can help NestJs CRUD

  







  
CRUD





  for RESTful APIs built with NestJs








  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

   





  Built with :purple_heart: by

  @MichaelYali and

  

    Contributors

  

  


    :star2: :eyes: :zap: :boom:

  








We believe that everyone who's working with NestJs and building some RESTful services and especially some CRUD functionality will find `@nestjsx/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

## Packages

- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs](https://github.com/nestjsx/crud/wiki/Controllers#description))

- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/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://github.com/nestjsx/crud/wiki/Requests#frontend-usage))

- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs](https://github.com/nestjsx/crud/wiki/ServiceTypeorm))

## Documentation

- :dart: [General Information](https://github.com/nestjsx/crud/wiki#why)

- :video_game: [CRUD Controllers](https://github.com/nestjsx/crud/wiki/Controllers#description)

- :horse_racing: [CRUD ORM Services](https://github.com/nestjsx/crud/wiki/Services#description)

- :trumpet: [Handling Requests](https://github.com/nestjsx/crud/wiki/Requests#description)

## 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 contribute. [[Contribute](CODE_OF_CONDUCT.md)].



### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/nestjsx#backer)]

#### Individuals



#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/nestjsx#sponsor)]





















## License

[MIT](LICENSE)