Awesome
<p align="center"> <img src="./nestjs.jpg" alt="NESTJS" /> <img src="./yeoman.png" alt="YEOMAN" /> <h1 align="center">NESTJS GENERATOR</h1> <p align="center">A yeoman generator for nestjs apps.</p> </p>ABOUT
This generator helps you create a NestJS app with ease. It also comes with support for the following
- Decorators
- Exceptions
- Guards
- Interceptors
- Middlewares
- Modules
OPTIONS
NestJS app options available
- SQL Typeorm app
- Mongoose app
- Seqelize app
- Passport app
- Graph QL apollo app
- Mongo Typeorm app
- Configurable Mongoose app
USAGE
Install dependencies
$ npm install -g yo
$ npm install -g generator-nestjs-app
The to create an app, run
$ yo nestjs-app
For other components run
$ yo nestjs-app:[COMPONENT] [NAME]
For example
$ yo nestjs-app:middleware app-auth
$ yo nestjs-app:decorator roles
OPTIONS
yo nestjs-app
(For creating a NestJS app)
--skip-install
- Skips installation of dependencies when bootstrappping an app
--npm
- Install dependencies with npm
--yarn
- Install dependencies with yarn
yo nestjs-app:[COMPONENT] [NAME]
(For creating components)
[COMPONENT]
- The type of the component to be created
[NAME]
- The name of the component to be created
yo nestjs-app:module [NAME]
(For creating a nestjs module)
[NAME]
- The name of the module to be created (required)
ARGUMENTS
--mongoose-module
--sequelize-module
--sql-typeorm
--mongo-typeorm
--graphql-module
FILE AND COMPONENT NAMING
By Angular File Naming Convention, names for components should be in kebab case. For example
yo nestjs-app:decorator app-user-routes
This creates a decorator with filename app-user-routes.decorator.ts
decorator name AppUserRoutesDecorator
CONTRIBUTIONS AND ISSUES
Contributions and filing of issues are gladly welcome. Before contributing, be sure to read the CONTRIBUTING GUIDE
-
For making pull requests, you can use the PR template
-
For submitting, you can use the ISSUES template