API NEST STARTER

Introduction

Start an API using NestJS framework with all the tedious commit lint settings and so on.

Prerequisites

• NodeJS (^v10.12.0)
• Yarn (^v1.10.0) (preferably) or Npm (^v6.4.0)
• Nest CLI (optional)

Getting Started

1. Install dependencies: yarn install
2. Configure your .env environments based on .env.example
3. Start your application:
   1. Development: yarn start
   2. Watch mode: yarn start:dev
   3. Production: yarn start:prod (run the build before: yarn build)

Deployment

CircleCI configured with 4 jobs:

1. [Install dependencies]: Install all dependencies with yarn and save cache.
2. [Lint]: check the link for all code.
3. [Tests]: run all unit tests and e2e.
4. [Build]: criar aplicativo com o Docker.

Note: deploy job not configured because it varies for each type of application.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Changelog

See CHANGELOG

Authors

• David Vilaça - davidpvilaca

License

Every code patch accepted in taiga codebase is licensed under MIT.