feat: add docker compose dev env

Signed-off-by: Vitor Hugo Salgado <[email protected]>

Author: vitorsalgado

Makefile

@@ -5,9 +5,15 @@ SHELL := /bin/bash
 help:
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
 
-lint: ## Run all lint and code style tools
-	npm run lint
-	npm run prettier:ci
+up: ## Run a development environment with Docker Compose.
+	@docker-compose -f ./deployments/dev/docker-compose.yml up
+
+down: ## Stop Docker Compose development environment.
+	@docker-compose -f ./deployments/dev/docker-compose.yml down
+
+dev-clean: ## Clean Docker Compose development environment.
+	@docker-compose -f ./deployments/dev/docker-compose.yml down --remove-orphans --volumes
+
 
 nvm: ## Install Node.js version described on .nvmrc
 	[ -s "$$HOME/.nvm/nvm.sh" ] && . "$$HOME/.nvm/nvm.sh" && \

README.md

@@ -1,21 +1,16 @@
 <h1 align="center">Node.js Starter ToolKit</h1>
 
 <p align="center">
-    <img src="docs/assets/logo.png" alt="Logo" />
-    <br/>
     <i>Starter Project for a Node.js application using <strong>TypeScript</strong> with all boring stuff already configured.</i>
 </p>
 
 <p align="center">
   <a href="https://github.com/vitorsalgado/create-nodejs-ts/actions/workflows/ci.yml">
     <img src="https://github.com/vitorsalgado/create-nodejs-ts/actions/workflows/ci.yml/badge.svg">
-  </a>&nbsp
-  <a href="https://codecov.io/gh/vitorsalgado/create-nodejs-ts">
-    <img src="https://codecov.io/gh/vitorsalgado/create-nodejs-ts/branch/main/graph/badge.svg?token=YA1LHGXU38"/>
-  </a>&nbsp
+  </a>
   <a href="https://github.com/prettier/prettier">
     <img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"/>
-  </a>&nbsp
+  </a>
 </p>
 
 ## Overview
@@ -50,7 +45,7 @@ The final folder will the parameter `destination` concatenated with parameter `a
 - Prettier
 - Standard Version
 - Nodemon
-- Docker
+- Docker | Docker Compose
 
 ## License
 

build/docker/Dockerfile.dev

@@ -0,0 +1,3 @@
+FROM node:14.17.3
+WORKDIR /app
+CMD npm start

cmd/create-nodejs-ts/index.js

@@ -21,7 +21,6 @@ const Ignores = [
   '.yarn/install-state.gz',
   'cmd',
   'coverage',
-  'deployments',
   'dist',
   'docs',
   'node_modules',

deployments/dev/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3.8'
+
+services:
+  dev-app:
+    build:
+      context: ./
+      dockerfile: ../../build/docker/Dockerfile.dev
+    container_name: nodejs-ts.dev-app
+    volumes:
+      - ../../:/app
+    ports:
+      - 8080:8080

src/index.spec.ts

@@ -1,7 +1,12 @@
+/**
+ * This is a sample test suite.
+ * Replace this with your implementation.
+ */
+
 import { spawn } from 'child_process'
 import Path from 'path'
 
-describe('CMD - App', function () {
+describe('Example Test', function () {
   it('should init without errors', async function () {
     process.env.PORT = '0'
 

src/index.ts

@@ -1,5 +1,10 @@
 #!/usr/bin/env node
 
+/**
+ * This is a sample HTTP server.
+ * Replace this with your implementation.
+ */
+
 import 'dotenv/config'
 import { createServer, IncomingMessage, ServerResponse } from 'http'