prodify-s v1.2.7
NestJS API Scaffolding (prodify-s)
This is a supurior package for production level Nestjs application generator, which is can be used as a starting point for any Backend application with NestJS.
Installation š
$ npm install -g prodify-s
Why another nestJS generator ā
This generates the API scaffolding with the error handler ā ļø, which is always a good idea.
Only installs the bare bones š and "mostly" required dependencies whenever you try to start a new nestjs application.
Quick Start šāāļø
The quickest way to get started with nestjs is to utilize the executable prodify-s
(OR @prodify-s
) to generate an application as shown below:
Create (and start) the app in current folder:
$ nest start .
$ npm run start:dev
OR, create (and start) the app (in myNestApp
folder):
$ sj-plz myNestApp OR prodify myNestApp
$ cd myNestApp
$ npm run start:dev
This will basically create this structure in your folder
.
āāā dev.env
āāā local.env
āāā common
āāā node_modules
āāā nest-cli.json
āāā package.json
āāā tsconfig.json
āāā tsconfig.build.js
āāā .prettierrc
āāā .eslintrc.js
āāā .gitignore
āāā test
āāā app.e2e-spec.ts
āāā jest-e2e.json
āāā src
āāā common
āāā database
āāā database.config.ts
āāā database.module.ts
āāā database.providers.ts
āāā dbConfig.interface.ts
āāā constants
āāā index.ts
āāā users
āāā dto
āāā entities
āāā users.controller.spec.ts
āāā users.controller.ts
āāā users.service.ts
āāā users.module.ts
āāā users.service.spec.ts
āāā util
āāā db-queries.ts
āāā response.handler.ts
āāā app.controller.ts
āāā app.module.ts
āāā app.service.ts
āāā main.ts
This is how easy it is to get going.
What dependencies it installs ?
- rxjs - nest reactive programming using observable
- dotenv - for env variables
- mysql2 - to create mysql db connection
- nest (dev) - contains all neccessary import files of nest
Command Line Options
Actually NONE is required š as of now, incase I continue this project OR I'll get requests then certainly this is not the end.
Author āļø
License š«
Contribute š¤
You can fork this repo and send me a PR.