nodejs-quickstart-structure 1.6.1 → 1.8.0

package/templates/common/docker-compose.yml.ejs

@@ -1,139 +1,156 @@
-services:
-  app:
-    build: .
-    ports:
-      - "${PORT:-3000}:3000"
-<%_ if (database !== 'None' || communication === 'Kafka') { -%>
-    depends_on:
-<%_ if (database !== 'None') { -%>
-      - db
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-      - kafka
-<%_ } -%>
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-    environment:
-      - KAFKA_BROKER=kafka:29092
-      - KAFKAJS_NO_PARTITIONER_WARNING=1
-      - PORT=3000
-<%_ if (database !== 'None') { -%>
-      - DB_HOST=db
-<%_ if (database === 'MySQL') { -%>
-      - DB_USER=root
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
-      - DB_USER=postgres
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-<%_ } -%>
-<%_ } -%>
-<%_ } else { -%>
-    environment:
-      - PORT=3000
-<%_ if (database !== 'None') { -%>
-      - DB_HOST=db
-<%_ if (database === 'MySQL') { -%>
-      - DB_USER=root
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
-      - DB_USER=postgres
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-<%_ } -%>
-<%_ } -%>
-<%_ } -%>
-<%_ if (database !== 'None') { -%>
-  db:
-<%_ if (database === 'MySQL') { -%>
-    image: mysql:8.0
-    restart: always
-    environment:
-      MYSQL_ROOT_PASSWORD: root
-      MYSQL_DATABASE: <%= dbName %>
-    ports:
-      - "${DB_PORT:-3306}:3306"
-    volumes:
-      - ./flyway/sql:/docker-entrypoint-initdb.d
-<%_ } else if (database === 'PostgreSQL') { -%>
-    image: postgres:15
-    restart: always
-    environment:
-      POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: root
-      POSTGRES_DB: <%= dbName %>
-    ports:
-      - "${DB_PORT:-5432}:5432"
-    volumes:
-      - ./flyway/sql:/docker-entrypoint-initdb.d
-<%_ } else if (database === 'MongoDB') { -%>
-    image: mongo:latest
-    restart: always
-    environment:
-      MONGO_INITDB_DATABASE: <%= dbName %>
-    ports:
-      - "${DB_PORT:-27017}:27017"
-    volumes:
-      - mongodb_data:/data/db
-
-  mongo-migrate:
-    image: node:18-alpine
-    working_dir: /app
-    volumes:
-      - .:/app
-    command: sh -c "npm install migrate-mongo && npm run migrate"
-    environment:
-      - DB_HOST=db
-      - DB_NAME=<%= dbName %>
-    depends_on:
-      - db
-<%_ } -%>
-<%_ } -%>
-<%_ if (database !== 'MongoDB' && database !== 'None') { -%>
-  flyway:
-    image: flyway/flyway
-    command: -connectRetries=60 migrate
-    volumes:
-      - ./flyway/sql:/flyway/sql
-    environment:
-<%_ if (database === 'MySQL') { -%>
-      FLYWAY_URL: jdbc:mysql://db:3306/<%= dbName %>
-      FLYWAY_USER: root
-      FLYWAY_PASSWORD: root
-<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
-      FLYWAY_URL: jdbc:postgresql://db:5432/<%= dbName %>
-      FLYWAY_USER: postgres
-      FLYWAY_PASSWORD: root
-<%_ } -%>
-    depends_on:
-      - db
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-  zookeeper:
-    image: confluentinc/cp-zookeeper:7.4.0
-    environment:
-      ZOOKEEPER_CLIENT_PORT: 2181
-      ZOOKEEPER_TICK_TIME: 2000
-    ports:
-      - "${ZOOKEEPER_PORT:-2181}:2181"
-
-  kafka:
-    image: confluentinc/cp-kafka:7.4.0
-    depends_on:
-      - zookeeper
-    ports:
-      - "${KAFKA_PORT:-9092}:9092"
-    environment:
-      KAFKA_BROKER_ID: 1
-      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
-      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:29092,PLAINTEXT_HOST://localhost:9092
-      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
-      KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT
-      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
-<%_ } -%>
-<%_ if (database !== 'None') { -%>
-volumes:
-  <%= database.toLowerCase() %>_data:
-<%_ } -%>
+services:
+  app:
+    build: .
+    ports:
+      - "${PORT:-3000}:3000"
+<%_ if (database !== 'None' || communication === 'Kafka') { -%>
+    depends_on:
+<%_ if (database !== 'None') { -%>
+      - db
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+      - kafka
+<%_ } -%>
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+    environment:
+      - KAFKA_BROKER=kafka:29092
+      - KAFKAJS_NO_PARTITIONER_WARNING=1
+      - PORT=3000
+<%_ if (caching === 'Redis') { -%>
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - REDIS_PASSWORD=
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+      - DB_HOST=db
+<%_ if (database === 'MySQL') { -%>
+      - DB_USER=root
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      - DB_USER=postgres
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+<%_ } -%>
+<%_ } -%>
+<%_ } else { -%>
+    environment:
+      - PORT=3000
+<%_ if (caching === 'Redis') { -%>
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - REDIS_PASSWORD=
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+      - DB_HOST=db
+<%_ if (database === 'MySQL') { -%>
+      - DB_USER=root
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      - DB_USER=postgres
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+<%_ } -%>
+<%_ } -%>
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+  db:
+<%_ if (database === 'MySQL') { -%>
+    image: mysql:8.0
+    restart: always
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: <%= dbName %>
+    ports:
+      - "${DB_PORT:-3306}:3306"
+    volumes:
+      - ./flyway/sql:/docker-entrypoint-initdb.d
+<%_ } else if (database === 'PostgreSQL') { -%>
+    image: postgres:15
+    restart: always
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: root
+      POSTGRES_DB: <%= dbName %>
+    ports:
+      - "${DB_PORT:-5432}:5432"
+    volumes:
+      - ./flyway/sql:/docker-entrypoint-initdb.d
+<%_ } else if (database === 'MongoDB') { -%>
+    image: mongo:latest
+    restart: always
+    environment:
+      MONGO_INITDB_DATABASE: <%= dbName %>
+    ports:
+      - "${DB_PORT:-27017}:27017"
+    volumes:
+      - mongodb_data:/data/db
+
+  mongo-migrate:
+    image: node:18-alpine
+    working_dir: /app
+    volumes:
+      - .:/app
+    command: sh -c "npm install migrate-mongo && npm run migrate"
+    environment:
+      - DB_HOST=db
+      - DB_NAME=<%= dbName %>
+    depends_on:
+      - db
+<%_ } -%>
+<%_ } -%>
+<%_ if (database !== 'MongoDB' && database !== 'None') { -%>
+  flyway:
+    image: flyway/flyway
+    command: -connectRetries=60 migrate
+    volumes:
+      - ./flyway/sql:/flyway/sql
+    environment:
+<%_ if (database === 'MySQL') { -%>
+      FLYWAY_URL: jdbc:mysql://db:3306/<%= dbName %>
+      FLYWAY_USER: root
+      FLYWAY_PASSWORD: root
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      FLYWAY_URL: jdbc:postgresql://db:5432/<%= dbName %>
+      FLYWAY_USER: postgres
+      FLYWAY_PASSWORD: root
+<%_ } -%>
+    depends_on:
+      - db
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+  zookeeper:
+    image: confluentinc/cp-zookeeper:7.4.0
+    environment:
+      ZOOKEEPER_CLIENT_PORT: 2181
+      ZOOKEEPER_TICK_TIME: 2000
+    ports:
+      - "${ZOOKEEPER_PORT:-2181}:2181"
+
+  kafka:
+    image: confluentinc/cp-kafka:7.4.0
+    depends_on:
+      - zookeeper
+    ports:
+      - "${KAFKA_PORT:-9092}:9092"
+    environment:
+      KAFKA_BROKER_ID: 1
+      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
+      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:29092,PLAINTEXT_HOST://localhost:9092
+      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
+      KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT
+      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
+<%_ } -%>
+<%_ if (caching === 'Redis') { -%>
+  redis:
+    image: redis:alpine
+    restart: always
+    ports:
+      - "${REDIS_PORT:-6379}:6379"
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+volumes:
+  <%= database.toLowerCase() %>_data:
+<%_ } -%>

package/templates/common/package.json.ejs

@@ -32,6 +32,8 @@
 <% } -%>
 <% if (communication === 'Kafka') { %>    "kafkajs": "^2.2.4",
 <% } -%>
+<% if (caching === 'Redis') { %>    "ioredis": "^5.3.2",
+<% } -%>
 <% if (viewEngine === 'EJS') { %>    "ejs": "^3.1.9",
 <% } -%>
 <% if (viewEngine === 'Pug') { %>    "pug": "^3.0.2",
@@ -55,6 +57,8 @@
     "@types/cors": "^2.8.17",
     "@types/dotenv": "^8.2.0",
     "@types/hpp": "^0.2.3",
+<% if (caching === 'Redis') { %>    "@types/ioredis": "^5.0.0",
+<% } -%>
 <% if (database === 'PostgreSQL') { %>    "@types/pg": "^8.10.9",
 <% } -%>
 <%_ if (database === 'MySQL' || database === 'PostgreSQL') { -%>

package/templates/mvc/js/src/controllers/userController.js.ejs

@@ -1,15 +1,30 @@
 const User = require('../models/User');
 const HTTP_STATUS = require('../utils/httpCodes');
 const logger = require('../utils/logger');
+<%_ if (caching === 'Redis') { -%>
+const redisService = require('../config/redisClient');
+<%_ } -%>
 
 const getUsers = async (req, res) => {
   try {
+<%_ if (caching === 'Redis') { -%>
+    const users = await redisService.getOrSet('users:all', async () => {
+<%_ if (database === 'MongoDB') { -%>
+        return await User.find();
+<%_ } else if (database === 'None') { -%>
+        return User.mockData;
+<%_ } else { -%>
+        return await User.findAll();
+<%_ } -%>
+    }, 60);
+<%_ } else { -%>
 <%_ if (database === 'MongoDB') { -%>
     const users = await User.find();
 <%_ } else if (database === 'None') { -%>
     const users = User.mockData;
 <%_ } else { -%>
     const users = await User.findAll();
+<%_ } -%>
 <%_ } -%>
     res.json(users);
   } catch (error) {
@@ -24,9 +39,15 @@ const createUser = async (req, res) => {
 <%_ if (database === 'None') { -%>
     const newUser = { id: String(User.mockData.length + 1), name, email };
     User.mockData.push(newUser);
+<%_ if (caching === 'Redis') { -%>
+    await redisService.del('users:all');
+<%_ } -%>
     res.status(HTTP_STATUS.CREATED).json(newUser);
 <%_ } else { -%>
     const user = await User.create({ name, email });
+<%_ if (caching === 'Redis') { -%>
+    await redisService.del('users:all');
+<%_ } -%>
     res.status(HTTP_STATUS.CREATED).json(user);
 <%_ } -%>
   } catch (error) {
@@ -35,3 +56,4 @@ const createUser = async (req, res) => {
 };
 
 module.exports = { getUsers, createUser };
+

package/templates/mvc/ts/src/config/swagger.ts.ejs

@@ -1,5 +1,4 @@
-<% if (communication === 'REST APIs') { %>
-import swaggerJsdoc from 'swagger-jsdoc';
+<% if (communication === 'REST APIs') { %>import swaggerJsdoc from 'swagger-jsdoc';
 
 const options = {
   definition: {

package/templates/mvc/ts/src/controllers/userController.ts.ejs

@@ -2,16 +2,31 @@ import { Request, Response } from 'express';
 import User from '@/models/User';
 import { HTTP_STATUS } from '@/utils/httpCodes';
 import logger from '@/utils/logger';
+<%_ if (caching === 'Redis') { -%>
+import redisService from '@/config/redisClient';
+<%_ } -%>
 
 export class UserController {
     async getUsers(req: Request, res: Response) {
         try {
+<%_ if (caching === 'Redis') { -%>
+            const users = await redisService.getOrSet('users:all', async () => {
+<%_ if (database === 'MongoDB') { -%>
+                return await User.find();
+<%_ } else if (database === 'None') { -%>
+                return User.mockData;
+<%_ } else { -%>
+                return await User.findAll();
+<%_ } -%>
+            }, 60);
+<%_ } else { -%>
 <%_ if (database === 'MongoDB') { -%>
             const users = await User.find();
 <%_ } else if (database === 'None') { -%>
             const users = User.mockData;
 <%_ } else { -%>
             const users = await User.findAll();
+<%_ } -%>
 <%_ } -%>
             res.json(users);
         } catch (error) {
@@ -30,9 +45,15 @@ export class UserController {
 <%_ if (database === 'None') { -%>
             const newUser = { id: String(User.mockData.length + 1), name, email };
             User.mockData.push(newUser);
+<%_ if (caching === 'Redis') { -%>
+            await redisService.del('users:all');
+<%_ } -%>
             res.status(HTTP_STATUS.CREATED).json(newUser);
 <%_ } else { -%>
             const user = await User.create({ name, email });
+<%_ if (caching === 'Redis') { -%>
+            await redisService.del('users:all');
+<%_ } -%>
             res.status(HTTP_STATUS.CREATED).json(user);
 <%_ } -%>
         } catch (error) {
@@ -45,3 +66,4 @@ export class UserController {
         }
     }
 }
+