https://github.com/dryerjs/dryerjs
The fastest way to build a GraphQL API with NestJS and Mongoose
https://github.com/dryerjs/dryerjs
graphql mongodb mongoose nestjs nodejs opensource
Last synced: 28 days ago
JSON representation
The fastest way to build a GraphQL API with NestJS and Mongoose
- Host: GitHub
- URL: https://github.com/dryerjs/dryerjs
- Owner: dryerjs
- License: mit
- Created: 2023-09-23T15:26:59.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-20T13:48:02.000Z (8 months ago)
- Last Synced: 2025-04-29T22:24:19.407Z (about 1 month ago)
- Topics: graphql, mongodb, mongoose, nestjs, nodejs, opensource
- Language: TypeScript
- Homepage: https://dryerjs.com
- Size: 1.5 MB
- Stars: 98
- Watchers: 1
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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.
[](https://codecov.io/gh/dryerjs/dryerjs)
[](https://github.com/dryerjs/dryerjs/actions)
[](https://github.com/dryerjs/dryerjs/actions)
[](https://www.npmjs.com/package/dryerjs)
[](https://discord.gg/mBZN86W5Fa)
[](https://paypal.me/briandryerjs)
## Documentation
Checkout the documentation at [dryerjs.com](https://dryerjs.com) for more information.
## Getting Started
To get started with DryerJS, follow these steps:
1. Prepare:
```bash
# 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:
```bash
npm i dryerjs
```
3. Declare your first model on `src/user.ts`:
```typescript
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:
```typescript
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({
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
```bash
npm run start:dev
```
6. Open browser and go to [http://localhost:3000/graphql](http://localhost:3000/graphql) to see the GraphQL playground.
## Contributing
Please read [CONTRIBUTING.md](https://github.com/dryerjs/dryerjs/blob/master/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](https://github.com/dryerjs/dryerjs/blob/master/LICENSE) for details.