Update boilerplate

Author: oscaroceguera

.gitignore

@@ -1,2 +1,3 @@
 node_modules
-coverage
+coverage
+.DS_Store

Dockerfile.dev

@@ -1,23 +1,12 @@
-FROM node:13.2.0-stretch-slim
+FROM node:10.19.0-buster-slim
 
-LABEL Name=boilerplate-node-postgres-dev Version=1.0.0
+LABEL Name=boilerplate-backend Version=1.0.0
 
 EXPOSE 5000
 #Adjust localtime to your needs
 #Set locale
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN   apt-get update && apt-get install -y --no-install-recommends \
-        locales \
-        tzdata \
-        ca-certificates \
-        libpq-dev \
-        && sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen \
-        && echo 'LANG="en_US.UTF-8"'>/etc/default/locale \
-        && dpkg-reconfigure --frontend=noninteractive locales \
-        && update-locale LANG=en_US.UTF-8 \
-        && apt-get clean && rm -rf /var/lib/apt/lists/*
-
 RUN mkdir /app && chown node:node /app
 
 USER node
@@ -32,4 +21,4 @@ ENV PATH=/app/node_modules/.bin:$PATH
 
 WORKDIR /app/node_app
 
-CMD ["npm", "run", "dev"]
+CMD ["npm", "run", "dev"]

README.md

@@ -1,27 +1,15 @@
-# Node.js/Express.js/Postgresql/ boilerplate with Docker
+# Run project
 
-**Stack**:
+docker-compose -f docker-compose-dev.yml up --build
 
-- Node
-- Express
-- Nodemon
-- Pg
-- Sequelize
-- Jest
-- Supertest
-- Eslint
-- Prettier
-- Docker
-- Docker-compose
+# Access to container
 
-> Editor recomended is "Visual Studio Code"
+docker exec -ti -u root #container_id /bin/bash
 
-**Run the boilerplate**
+# Generate model
 
-1. Execute in terminal `docker-compose up --build` in the root _boilerplate-node-express-postgresql-with-docker_ folder.
+npx sequelize-cli model:generate --name User --attributes firstName:string,lastName:string,email:string
 
-2. In other terminal execute `npm install` in the root folder _boilerplate-node-express-postgresql-with-docker_ to install local dependencies for the good practices of code, dependencies like a eslint, prettier, pre-commit, etc.
+# Migrate
 
-**Visual Studio Code**
-
-For the good practices of code, activate the option `Editor: Format On Save` in the **setting** section.
+sequelize db:migrate --url "postgres://hackademy_user:tupass@postgres:5432/hackademydbtest"

apidoc.json

@@ -0,0 +1,8 @@
+{
+  "name": "Caritbot API documentation",
+  "version": "1.0.0",
+  "description": "API Caritbot Application",
+  "template": {
+    "forceLanguage": "en"
+  }
+}

config/config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  PORT: process.env.PORT,
+  DB: {
+    username: process.env.DB_USER,
+    password: process.env.DB_PASSWORD,
+    database: process.env.DB_NAME,
+    host: process.env.DB_HOST,
+    port: process.env.DB_PORT,
+    dialect: 'postgres',
+    logging: false
+  }
+};

config/database.js

@@ -0,0 +1,8 @@
+import Sequelize from 'sequelize';
+import { DB } from './config';
+
+export default new Sequelize(DB.database, DB.username, DB.password, {
+  host: DB.host,
+  port: DB.port,
+  dialect: DB.dialect
+});

database/migrations/20210507053653-create-user.js

@@ -0,0 +1,33 @@
+'use strict';
+module.exports = {
+  up: (queryInterface, Sequelize) => {
+    return queryInterface.createTable('Users', {
+      id: {
+        allowNull: false,
+        autoIncrement: true,
+        primaryKey: true,
+        type: Sequelize.INTEGER
+      },
+      firstName: {
+        type: Sequelize.STRING
+      },
+      lastName: {
+        type: Sequelize.STRING
+      },
+      email: {
+        type: Sequelize.STRING
+      },
+      createdAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      },
+      updatedAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      }
+    });
+  },
+  down: (queryInterface, Sequelize) => {
+    return queryInterface.dropTable('Users');
+  }
+};

database/models/index.js

@@ -0,0 +1,39 @@
+const fs = require('fs');
+const path = require('path');
+const Sequelize = require('sequelize');
+const basename = path.basename(__filename);
+const { DB } = require('../../config/config');
+const config = DB;
+const db = {};
+
+const sequelize = new Sequelize(
+  config.database,
+  config.username,
+  config.password,
+  {
+    host: config.host,
+    dialect: config.dialect
+  }
+);
+
+fs.readdirSync(__dirname)
+  .filter(file => {
+    return (
+      file.indexOf('.') !== 0 && file !== basename && file.slice(-3) === '.js'
+    );
+  })
+  .forEach(file => {
+    const model = sequelize['import'](path.join(__dirname, file));
+    db[model.name] = model;
+  });
+
+Object.keys(db).forEach(modelName => {
+  if (db[modelName].associate) {
+    db[modelName].associate(db);
+  }
+});
+
+db.sequelize = sequelize;
+db.Sequelize = Sequelize;
+
+module.exports = db;

database/models/user.js

@@ -0,0 +1,16 @@
+'use strict';
+module.exports = (sequelize, DataTypes) => {
+  const User = sequelize.define(
+    'User',
+    {
+      firstName: DataTypes.STRING,
+      lastName: DataTypes.STRING,
+      email: DataTypes.STRING
+    },
+    {}
+  );
+  User.associate = function(models) {
+    // associations can be defined here
+  };
+  return User;
+};

docker-compose-dev.yml

@@ -0,0 +1,41 @@
+version: '3.3'
+services:
+  postgres:
+    image: 'postgres:12.2'
+    ports:
+      - 5434:5432
+    environment:
+      - POSTGRES_USER=user_db
+      - POSTGRES_DB=boilerplate_db
+      - POSTGRES_PASSWORD=tupass
+    volumes:
+      - 'pgdata-boilerplate:/var/lib/postgresql/data'
+
+  api:
+    depends_on:
+      - postgres
+    build:
+      dockerfile: Dockerfile.dev
+      context: .
+    restart: unless-stopped
+    ports:
+      - '5050:5000'
+    volumes:
+      - .:/app/node_app
+      - ./package.json:/app/package.json
+      - ./package-lock.json:/app/package-lock.json
+      - notused:/app/node_modules
+    environment:
+      - TZ=America/Mexico_City
+      - LC_CTYPE=en_US.UTF-8
+      - LC_ALL=en_US.UTF-8
+      - DB_USER=user_db
+      - PORT=5000
+      - DB_HOST=postgres
+      - DB_NAME=boilerplate_db
+      - DB_PASSWORD=tupass
+      - DB_PORT=5432
+
+volumes:
+  pgdata-boilerplate:
+  notused: