https://github.com/denpalrius/docker-nestjs-starter

NestJs app with Docker
https://github.com/denpalrius/docker-nestjs-starter

azure azure-devops docker nestjs nodejs typescript

Last synced: 3 months ago
JSON representation

NestJs app with Docker

• Host: GitHub
• URL: https://github.com/denpalrius/docker-nestjs-starter
• Owner: denpalrius
• Created: 2019-04-10T11:58:47.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T00:57:30.000Z (almost 2 years ago)
• Last Synced: 2023-06-09T02:45:39.763Z (over 1 year ago)
• Topics: azure, azure-devops, docker, nestjs, nodejs, typescript
• Language: TypeScript
• Size: 1.77 MB
• Stars: 77
• Watchers: 5
• Forks: 43
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Runnig NestJs in a Docker Container

This is a [Nest Js](https://github.com/nestjs/nest) project configured for use with Docker

## Installation

```bash

$ npm install

```

Ensure also that [Docker is installed](https://docs.docker.com/engine/install) on your work station

## Running the app using node server (the normal way)

```bash

# 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](https://code.visualstudio.com/docs/containers/debug-node)

## Using Docker

```sh

# 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

```sh

# 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

```sh

# Get the container ID

$ docker ps

# View logs

$ docker logs 

# Enter the container (In alpine, use sh because bash is not installed by default)

$ docker exec -it  /bin/sh

```

## Testing

```bash

# 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](LICENSE)