rajeevbbqq / nest-dockerized

Description

Project is scaffolded with below tools

	Tools
Framework	Nest JS
Database	Postgres
Containeraization	Docker
Database ORM	TypeORM
Documentation	Swagger

Live demo

	Link
Documentation	Access documentation
Application Server	Access

Note: When invoking API make sure to authorize with JWT token mentioned in the Swagger doc and fill all the required fields mentioned.

Deploying Project locally with Docker

Prequisite: Docker should be installed on your machine to execute below commands. Get docker

Build the NestJS project

docker compose build

Starting application server as daemon

docker compose up -d

Project starts on http://localhost:3000

Testing the app

# e2e tests for testing API services
npm run test:e2e

Running the app locally for development

# development with watch mode
$ npm run start:dev

Generating DB scripts

It is possible to generate migration scripts based on the entities created or modified.

npm run migration:generate

The above command creates migration scripts automatically

Modify database configs

Database is scaffolded with Postgres image pulled from docker hub, credentials can be updated in docker-compose.yml.

Side note

.env published as part of repo does not contains any production secrets or configs. Credentials stored inside .env is for running application without hassles.

License

Nest is MIT licensed.