/dzi-backend

Primary LanguageTypeScript

Nest Logo

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

NPM Version Package License NPM Downloads Travis Linux Coverage Gitter Backers on Open Collective Sponsors on Open Collective

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app


Requirements:
  • Postgresql 11+
  • Node v12+

Configuration:

Changes in the environment file.

  1. Delete the .demo part from the .env.demo file.
  2. Create a database in the postgresql and update the value of this attribute with the database that you created DB_NAME_DEVELOPMENT=development_database_name
  3. Update
    • DB_USER=username_used_during_installation
    • DB_PASS=password_used_during_installation
    with the username and the password that you used while installing the postgresql. Defaults are postgres for both the username and the password.
  4. Update TOKEN_EXPIRATION=number_followed_by_h with the amount of time you want the token to be valid.
    eg. TOKEN_EXPIRATION=1h here the token will be valid for 1 hour.

In order to check the implemented endpoint, hit the swagger endpoint i.e. http://localhost:3000/api 

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

# running the unit test cases and check the 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.

License

Nest is MIT licensed.