Merge pull request #1 from mugarate12/feature/docker-builds

Feature/docker builds

Author: mugarate12

README.md

@@ -7,7 +7,8 @@
 - [Getting Started](#getting-started)
 - [Usage](#usage)
 - [Folder Structure](#folder-structure)
-- [Scripts in project](#scripts-in-project)
+- [Basic Scripts In Project](#basic-scripts-in-project)
+- [Docker Scripts In Project](#docker-scripts-in-project)
 - [Future Features](#future-features)
 
 ## Getting Started
@@ -37,7 +38,11 @@ project
 │   CHANGELOG.md
 │   README.md
 │   docker-compose.yml
+│   docker-compose.test.yml
+│   docker-compose.dev.yml
 │   Dockerfile
+│   Dockerfile.test
+│   Dockerfile.dev
 │   babel.config.js
 │   package-lock.json
 │   package.json
@@ -70,8 +75,9 @@ project
 │       │   index.ts
 ```
 
-## Scripts in project
-- Your package.json have initial commands to build, run and create server to development
+## Basic Scripts In Project
+
+- Your package.json have initial commands to build, run, test and create server to development
 
 build your project:
 ```shell
@@ -92,8 +98,24 @@ run all of tests in project:
 ```shell
 npm run test
 ```
+> Test your application run correctlly to send HTTP GET to localhost:8000
+
+## Docker Scripts In Project
+
+run your project in docker to production:
+```shell
+npm run docker:prod
+```
 
-- Test your application run correctlly to send HTTP GET to localhost:8000
+run your project in docker to development:
+```shell
+npm run docker:dev
+```
+
+run your project in docker to test:
+```shell
+npm run docker:test
+```
 
 ## Future Features
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "basic-node-ts-config",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Configuração básica para um ambiente de desenvolvimento com NodeJs + TypeScript",
   "main": "./lib/copyFile.js",
   "preferGlobal": true,

package.json

@@ -0,0 +1,20 @@
+# Or whatever Node version/image you want
+FROM node:lts
+
+# Create app directory
+WORKDIR '/var/www/app'
+
+# Copy all files starts with package and ends wit .json 
+COPY package*.json ./
+
+# Install app dependencies
+RUN npm i 
+
+# Copy all files from current directory to app directory
+COPY . .
+
+# Listen on port 8000
+EXPOSE 8000
+
+# Run the app
+CMD [ "npm", "run", "dev" ]

project/Dockerfile.dev

@@ -0,0 +1,20 @@
+# Or whatever Node version/image you want
+FROM node:lts
+
+# Create app directory
+WORKDIR '/var/www/app'
+
+# Copy all files starts with package and ends wit .json 
+COPY package*.json ./
+
+# Install app dependencies
+RUN npm i 
+
+# Copy all files from current directory to app directory
+COPY . .
+
+# Listen on port 8000
+EXPOSE 8000
+
+# Run the app
+CMD [ "npm", "run", "test:docker" ]

project/Dockerfile.test

@@ -6,7 +6,8 @@
 
 - [Getting Started](#getting-started)
 - [Configuration](#configuration)
-- [Scripts](#scripts)
+- [Basic Scripts](#basic-scripts)
+- [Docker Scripts](#docker-scripts)
 - [Folder Structure](#folder-structure)
 - [Docker](#docker)
 
@@ -29,7 +30,7 @@ Set the environment variables in the `.env` file like the `.env.example` file.
 -  `NODE_ENV`: Set type of environment to run the server mode (development, production, test).
 -  `REDIS_URL`: URI of the Redis server. By default is `redis://localhost:6379`.
 
-## Scripts
+## Basic scripts
 
 - Your package.json have initial commands to build, run, test and create server to development
 
@@ -52,8 +53,24 @@ run all of tests in project:
 ```shell
 npm run test
 ```
+> Test your application run correctlly to send HTTP GET to localhost:8000
 
-- Test your application run correctlly to send HTTP GET to localhost:8000
+## Docker scripts
+
+run your project in docker to production:
+```shell
+npm run docker:prod
+```
+
+run your project in docker to development:
+```shell
+npm run docker:dev
+```
+
+run your project in docker to test:
+```shell
+npm run docker:test
+```
 
 ## Folder Structure
 
@@ -66,7 +83,11 @@ project
 │   CHANGELOG.md
 │   README.md
 │   docker-compose.yml
+│   docker-compose.test.yml
+│   docker-compose.dev.yml
 │   Dockerfile
+│   Dockerfile.dev
+│   Dockerfile.test
 │   babel.config.js
 │   package-lock.json
 │   package.json

project/README.md

@@ -0,0 +1,25 @@
+version: "3.9" 
+
+services:
+  redis:
+    image: redis
+    container_name: cache
+    expose:
+      - 6379
+
+  app:
+    build: ./Dockerfile.dev
+    volumes:
+      - .:/src
+      - ./:/var/www/app # docker workdir
+    depends_on:
+      - redis
+    ports:
+      - "8000:8000"
+    environment:
+      - REDIS_URL=redis://cache
+      - NODE_ENV=development
+      - PORT=8000
+    command: 
+      sh -c 'npm run dev'
+    

project/docker-compose.dev.yml

@@ -0,0 +1,24 @@
+version: "3.9" 
+
+services:
+  redis:
+    image: redis
+    container_name: cache
+    expose:
+      - 6379
+
+  app:
+    build: ./Dockerfile.test
+    volumes:
+      - ./:/var/www/app # docker workdir
+    depends_on:
+      - redis
+    ports:
+      - "8000:8000"
+    environment:
+      - REDIS_URL=redis://cache
+      - NODE_ENV=test
+      - PORT=8000
+    command: 
+      sh -c 'npm run test:docker'
+    

project/docker-compose.test.yml

@@ -5,9 +5,13 @@
   "main": "src/app.js",
   "scripts": {
     "build": "tsc",
-    "dev": "ts-node-dev --respawn --transpile-only --ignore-watch node_modules src/server.ts",
+    "dev": "ts-node-dev --poll --respawn --transpile-only --ignore-watch node_modules src/server.ts",
     "start": "npm run build&&node build/src/server.js",
-    "test": "SET NODE_ENV=test&&jest"
+    "test": "SET NODE_ENV=test&&jest",
+    "test:docker": "jest",
+    "docker:test": "docker-compose -f ./docker-compose.test.yml up",
+    "docker:dev": "docker-compose -f ./docker-compose.dev.yml up",
+    "docker:prod": "docker-compose -f ./docker-compose.yml up"
   },
   "keywords": [],
   "author": "",