/template-nodejs-nest-postgresql

https://nodejs-nest-postgresql.cyclic.app/api

Primary LanguageTypeScript

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

Nest framework TypeScript starter repository.

CHAMELEON STACK - KANBAN

Docker Configuration

The first step is to configure Docker. For each operating system, you need to follow a step-by-step guide:

  • Linux
               https://docs.docker.com/desktop/install/linux-install/
  • Windows (WSL installation and configuration required)
               https://docs.docker.com/desktop/install/windows-install/
  • macOS
               https://docs.docker.com/desktop/install/mac-install/

Installing the Container for Project Execution

To install the container that will run your project, you need to execute the following command in the terminal:

docker run --name postgres -e POSTGRES_PASSWORD=mypassword -p 5432:5432 -d postgres

CHAMELEON STACK - KANBAN

📋 PREREQUISITES

  • Docker
  • NodeJs
  • NPM

🔧 INSTALLATION PREREQUISITES

Installing NodeJS

Access the following link and download the LTS version

    https://nodejs.org/en

After that, just double-click on the file that was downloaded and install Node by clicking next until it is installed. Run the following command in a terminal (cmd, gitbash or others) to check the version:

    node --version

Also, check the installed NPM version:

    npm --version

Installing Docker

The first step is to set up Docker. For each operating system, you need to follow a step-by-step process:

  • Linux
               https://docs.docker.com/desktop/install/linux-install/
  • Windows (WSL installation and configuration are required)
               https://docs.docker.com/desktop/install/windows-install/
  • macOS
               https://docs.docker.com/desktop/install/mac-install/

Installing the Container for the Project

To install the container that will run in the project, you need to enter the following command in the terminal:

docker run --name postgres -e POSTGRES_PASSWORD=mypassword -p 5432:5432 -d postgres

In this step, install a DBMS and connect with docker credentials

⚙️ CONFIGURING THE PROJECT

Adding Database Connection Values to .env

Connect to the database created with the variables you used to create the Docker image. Create a file called ".env" at the root of the project and add the variables contained in the ".env.example" file with the value of the database connection URL(postgres://username:password@localhost:5432/database_name). The ".env" file, according to the container you created, would look something like this:

POSTGRESQL_URI=postgres://postgres:mypassword@localhost:5432/chameleon
NODE_ENV=dev

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# 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.

Stay in touch

License

Nest is MIT licensed.