Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashinzekene/generator-nestjs-app
ποΈ A yeoman generator for nestjs apps
https://github.com/ashinzekene/generator-nestjs-app
Last synced: about 1 month ago
JSON representation
ποΈ A yeoman generator for nestjs apps
- Host: GitHub
- URL: https://github.com/ashinzekene/generator-nestjs-app
- Owner: ashinzekene
- License: mit
- Created: 2018-01-19T02:18:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-24T10:18:55.000Z (about 5 years ago)
- Last Synced: 2024-10-12T16:06:14.469Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 362 KB
- Stars: 57
- Watchers: 7
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nestjs - Yeoman Generator - η¨δΊ nestsjs εΊη¨η¨εΊηθͺε¨ηζε¨γ (θ΅ζΊ / θΏθ‘)
README
NESTJS GENERATOR
A yeoman generator for nestjs apps.
### ABOUT
This generator helps you create a [NestJS](https://github.com/nestjs/nest) 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
```sh
$ npm install -g yo
$ npm install -g generator-nestjs-app
```
__The to create an app, run__
```sh
$ yo nestjs-app
```
__For other components run__
```sh
$ yo nestjs-app:[COMPONENT] [NAME]
```
For example
```sh
$ yo nestjs-app:middleware app-auth
```
```sh
$ 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](https://angular.io/guide/styleguide), 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](changelog.md)
- For making pull requests, you can use the [PR template](PULL_REQUEST-TEMPLATE.md)
- For submitting, you can use the [ISSUES template](ISSUE_TEMPLATE.md)
### LICENSE
[MIT LICENSE](LICENSE.md)