Home

Why?

NestJS is probably one of the best things that happened to Node.js community a couple of years ago. It was a missing part that provides a truly important architectural solution for a wide range of backend development aspects. But, despite the fact that it allows creating RESTful applications efficiently, an important CRUD scaffolding functionality that is present in many other HTTP frameworks was missing. That's why Nestjsx/crud came out. And we hope you'll find it very useful.

Structure

The project follows monorepository structural practice and contains several packages:

• @nestjs-crud/core - core package which provides @Crud() decorator for endpoints generation, global configuration, validation, helper decorators (docs)
• @nestjs-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)
• @nestjs-crud/typeorm - TypeORM package which provides base TypeOrmCrudService with methods for CRUD database operations (docs)
• @nestjs-crud/mikro-orm - MikroORM package which provides base MikroOrmCrudService with methods for CRUD database operations (docs)
• @nestjs-crud/drizzle - Drizzle package which provides base DrizzleCrudService with methods for CRUD database operations (docs)
• @nestjs-crud/prisma - (new in v2.0.0) Prisma package which provides base PrismaCrudService with methods for CRUD database operations (docs)
• @nestjs-crud/util - utility package with shared helper functions used internally

Upgrading from v1.0.x? See the v2 Migration guide.

Cloning and running tests

1. Clone this repository.

2. Run preparational scripts:

docker compose up -d
yarn install
yarn build
yarn test

Running an example project

1. Clone and prepare the project.

2. Prepare the database and start a project:

yarn db:prepare:typeorm:postgres
yarn start:typeorm

3. Use http://localhost:3000/docs to try it out.

4. The code of example projects can be found under integration folder.