asjadsaboor-10p / nodejs-tour-of-heroes

Node tour of heroes

A simple API for tour of heroes

Documentation

Prerequisites

1. docker and docker compose (lastest version) Docker & Docker-Compose
2. Mailgun and Sendgrid accounts

commands to get you started

1. git clone and go to project folder.
2. create .env file in config directory
3. npm install (install packages locally, since we don't mount node_modules in container)
4. npm run build:docker
5. npm run start:docker

A collection of useful commands which might be helpful

Logs

1. npm run logs

Linting / Code prettify

1. npm run lint
2. npm run lint:fix
3. npm run format:check
4. npm run format:fix:all

Run tests

1. npm run test

Create apidocs

1. npm run apidocs

Debug

1. uncomment following line from docker-compose.yml

#- --inspect-brk=0.0.0.0

2. create launch.json in .vscode folder, and copy following code

{
  "version": "0.2.0",
  "configurations": [{
    "type": "node",
    "request": "attach",
    "name": "Docker: Attach to Node",
    "port": 9229,
    "address": "localhost",
    "localRoot": "${workspaceFolder}/src",
    "remoteRoot": "/api/src",
    "protocol": "inspector"
  }]
}

Sample .env

NODE_ENV=local
PORT=4001