typescript-nestjs-starter v1.0.4

NestJs with TypeScript's application generator.

🧐 What is it?

nestjs is A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

🤔 Why typescript-nestjs-starter?

Nest (NestJS) is a framework for building efficient, scalable Node.js server-side applications. It uses progressive JavaScript, is built with and fully supports TypeScript (yet still enables developers to code in pure JavaScript) and combines elements of OOP (Object Oriented Programming), FP (Functional Programming), and FRP (Functional Reactive Programming).

Under the hood, Nest makes use of robust HTTP Server frameworks like Express (the default) and optionally can be configured to use Fastify as well!

Nest provides a level of abstraction above these common Node.js frameworks (Express/Fastify), but also exposes their APIs directly to the developer. This allows developers the freedom to use the myriad of third-party modules which are available for the underlying platform.

⚙️ Installation

$ npm install -g typescript-nestjs-starter

🚀 Quick Start

The quickest way to get started is use npx and pass in the name of the project you want to create. If you don't specify a project name, the default typescript-nestjs-starter will be used instead.

Create the app:

$ npx typescript-nestjs-starter "project name"

Start your typescript-nestjs-starter app in development mode at http://localhost:3000/

$ cd "project name" && npm run start

🎠 Available commands for the server.

• Run the Server in production mode : npm run start.
• Run the Server in development mode : npm run dev.
• Run all unit-tests: npm run test.
• Check for linting errors: npm run lint.

⛑ Code Structure(default)

│
├── /src
│   ├── /app
│   │   └── /users
│   │       ├── /dtos
│   │       │   └── users.dto.ts
│   │       │
│   │       ├── /interfaces
│   │       │   └── users.interface.ts
│   │       │
│   │       ├── /models
│   │       │   └── users.model.ts
│   │       │
│   │       ├── users.controller.spec.ts
│   │       ├── users.controller.ts
│   │       ├── users.module.ts
│   │       └── users.service.ts
│   │
│   ├── app.controller.spec.ts
│   ├── app.controller.ts
│   ├── app.module.ts
│   ├── app.service.ts
│   └── main.ts
│
├── /test
│   ├── app-e2e-spec.ts
│   └── jest-e2e.json
│
├── .gitignore
├── .prettierrc
├── jest.config.js
├── nest-cli.json
├── package-lock.json
├── package.json
├── tsconfig.build.json
├── tsconfig.json
└── tslint.json

💳 License

MIT

🤝 Contributors