oldmonad / docker-nestjs-starter

NestJs app with Docker

Runnig NestJs in a Docker Container

This is a Nest Js project configured for use with Docker

Installation

$ npm install

Ensure also that Docker is installed on your work station

Running the app using node server (the normal way)

# development
$ npm run start:dev
or
nest start

# Debug/watch
$ npm run start:debug

# production
$ npm run build:prod
$ npm start

Setting up the app for use with Docker

1. Add Dockerfile
2. Add docker-compose.yml
3. Add unnecessary files to .gitignore
4. Add .dockerignore and include the unnecessary files
5. Add nodemon-docker-debug.json
6. Add "debug": "nodemon -L --config nodemon-docker-debug.json" script to package.json
7. Configure VS Code for debugging the node js app with a container

Using Docker

# Build the image
$ docker build -t docker-nest-js:v1.0 .

# Run the image interactively
$ docker run -it -p 3000:3000 docker-nest-js:v1.0

Using Docker Compose

# Build the docker image
$ docker-compose build

# Start and login to the container
$ docker-compose up -d
$ docker-compose exec app sh

Other useful Docker commands

# Get the container ID
$ docker ps

# View logs
$ docker logs <container id>

# Enter the container (In alpine, use sh because bash is not installed by default)
$ docker exec -it <container id> /bin/sh

Testing

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Resources

Tutorial: https://qiita.com/rema424/items/36475ea7379e0d9c5972
Best practices: https://github.com/docker/docker-bench-security

License

MIT licensed