Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gilsonricardopeloso/api

API
https://github.com/gilsonricardopeloso/api

Last synced: about 6 hours ago
JSON representation

API

Awesome Lists containing this project

README

        


Webxnet Logo


Webxnet NestJS Boilerplate


NestJS is a progressive Node.js framework for building efficient and scalable server-side applications.


Explore the NestJS docs »




Table of Contents



  1. About the project


  2. Features

  3. Folder Structure


  4. Getting Started


  5. Roadmap

  6. Contributing

  7. License

## About The Project

[Webxnet](https://github.com/webxnet/wxn-nestjs-boilerplate) use NestJS framework for some of your backend service.


[NestJS](https://nestjs.com/) is a great Framework to start building very robust server-side applications. There are many great templates available on GitHub; however, We didn't find one that really suited our needs so We created this ~~very opinionated~~ one. We wanted a boilerplate that would integrate many of the great features Nest has to offer, _out-of-the-box_, with the minimun configuration effort to start bootstraping an application right away.

Of course, no template will suit every project as your needs may be different, but here's our contribution for anyone who finds it useful.

(back to top)

## Installation

```bash
$ npm install
```

## Running the app

```bash
# development
$ npm run start

# watch mode
$ npm run dev

# production mode
$ npm run start:prod
```

## Test

```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
```

## Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).

## Stay in touch

- Author - [Gilson Peloso](https://github.com/gilsonricardopeloso/)
- Website - [https://webxnet.com.br](https://webxnet.com.br/)
- Twitter - [@webxnet1](https://twitter.com/webxnet1)

## License

Nest is [MIT licensed](LICENSE).