dryerjs

DryerJS, leveraging the power of NestJS and Mongoose, automates the creation of CRUD GraphQL APIs from model declarations. It supports complex model relationships and offers extensive customization options, greatly reducing repetitive coding and enhancing development efficiency.

Documentation

Checkout the documentation at dryerjs.com for more information.

Getting Started

To get started with DryerJS, follow these steps:

1. Prepare:

   # init new nest project
   npm i -g @nestjs/cli && nest new my-project && cd my-project
   # install standard dependencies
   npm i @nestjs/graphql @nestjs/apollo @nestjs/mongoose
   # install peer dependencies
   npm i dataloader class-transformer class-validator
   # remove unrelated files
   npm run env -- rimraf src/app.(service|controller)*

2. Install DryerJS:

   npm i dryerjs

3. Declare your first model on src/user.ts:

   import { Definition, Property, Id, Skip, ObjectId } from 'dryerjs';
   
   @Definition()
   export class User {
     @Id()
     id: ObjectId;
   
     @Property()
     email: string;
   
     @Property({ update: Skip, output: Skip })
     password: string;
   
     @Property()
     name: string;
   }

4. Import your model and DryerJSModule in AppModule with other modules inside app.module.ts:

   import { Module } from '@nestjs/common';
   import { GraphQLModule } from '@nestjs/graphql';
   import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
   import { MongooseModule } from '@nestjs/mongoose';
   import { DryerModule } from 'dryerjs';
   
   import { User } from './user';
   
   @Module({
     imports: [
       GraphQLModule.forRoot<ApolloDriverConfig>({
         driver: ApolloDriver,
         autoSchemaFile: true,
         playground: true,
       }),
       MongooseModule.forRoot('mongodb://127.0.0.1:27017/test'),
       DryerModule.register({ definitions: [User] }),
     ],
   })
   export class AppModule {}

5. Start server

   npm run start:dev

6. Open browser and go to http://localhost:3000/graphql to see the GraphQL playground.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE file for details.