Merge pull request #100 from VictorAugDB/update-docs-to-use-docker-compose-commands

Update docs to use docker compose commands

Author: brunohcastro

.gitignore

@@ -3,5 +3,6 @@ dist/
 .index/
 *.log
 .idea/
-.vscode/
-coverage/
+coverage/
+.vscode/*
+!.vscode/launch.json

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Docker: Attach to Node",
+      "remoteRoot": "/api",
+      "port": 9229,
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "restart": true
+    },
+    {
+      "name": "Attach Locally",
+      "port": 9229,
+      "request": "attach",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "type": "node",
+      "restart": true
+    }
+  ]
+}

README.md

@@ -10,10 +10,29 @@ This version of the boilerplate is still in beta, so might contain abstractions
 
 ## How to run the server
 
+### Requisites
+* To run the project wit Docker you need to have Docker installed in your computer: [Docker](https://docs.docker.com/engine/install/)
+* To run locally you need to have project dependencies installed globally in your machine
+
 During development, the project can be run in two different ways.
 
+### With Docker
+
 If you want to just run the application in development mode, use the following command:
 
+```sh
+$ docker compose up
+```
+
+To run the application in debug mode in a way that the execution will stop when a debugger statement is called, use:
+
+```sh
+$ docker-compose -f docker-compose.yaml -f docker-compose.debug.yaml up
+```
+
+### Locally
+
+If you want to just run the application in development mode, use the following command:
 ```sh
 $ yarn dev
 ```
@@ -44,9 +63,19 @@ $ yarn remote [server address] [REPL port]
 
 ## Tests
 
-The boilerplate is prepared to run tests using Jest. We usually group the tests in folders called `__tests__` (following Jest convention) for each module of the application. To run the tests use the following command:
+The boilerplate is prepared to run tests using Jest. We usually group the tests in folders called `__tests__` (following Jest convention) for each module of the application. To run the tests use the following commands:
 
+### With Docker
 ```sh
+$ docker compose up
+
+$ yarn test
+```
+
+### Locally
+```sh
+$ yarn dev
+
 $ yarn test
 ```
 
@@ -81,6 +110,17 @@ This boilerplate follows ideas from multiple good software development practices
 
 To run your app in production mode, you'll need to follow these steps:
 
+### With Docker
+
+1. Define any environment variable important for production
+2. Go to `docker-compose.production.yaml` file, and add necessary configurations
+3. Run the following command:
+```sh
+$ docker-compose -f docker-compose.yaml -f docker-compose.production.yaml up
+```
+
+### Locally
+
 1. Build the application with `yarn build`
 2. Define any environment variable important for production
 3. Start the app with `yarn start`

docker-compose.debug.yaml

@@ -0,0 +1,6 @@
+services:
+  api:
+    command: bash -c "yarn install && yarn debug"
+    ports:
+      - 9229:9229
+

docker-compose.production.yaml

@@ -0,0 +1,3 @@
+services:
+  api:
+    command: bash -c "yarn install && yarn build && yarn start"

docker-compose.yaml

@@ -12,6 +12,7 @@ services:
       - .:/api
     ports:
       - 3000:3000
+      - 2580:2580
     environment:
       HOST: 0.0.0.0
       DB_HOST: mongodb://node-api-boilerplate-mongodb:27017

package.json

@@ -58,9 +58,10 @@
   },
   "scripts": {
     "prebuild": "rimraf dist",
+    "start": "node . --transpile-only --files .| pino-pretty -c -l",
     "build": "tsc -p tsconfig.prod.json",
     "dev": "tsnd --transpile-only --files src/index.ts | pino-pretty -c -l",
-    "debug": "tsnd --transpile-only --inspect --files src/index.ts | pino-pretty -c -l",
+    "debug": "tsnd --transpile-only --inspect=0.0.0.0:9229 --nolazy --files src/index.ts | pino-pretty -c -l",
     "cli": "tsnd --transpile-only --files src/index.ts --cli",
     "remote": "ts-node bin/replClient.ts",
     "test": "jest"

tsconfig.json

@@ -8,6 +8,7 @@
     "outDir": "./dist",
     "rootDir": "./src",
     "removeComments": false,
+    "inlineSourceMap": true,
     "strict": true,
     "noImplicitAny": false,
     "noUnusedLocals": true,