nodejs-quickstart-structure 1.4.3 → 1.6.1

package/templates/clean-architecture/ts/src/index.ts.ejs

@@ -5,6 +5,7 @@ import hpp from 'hpp';
 import rateLimit from 'express-rate-limit';
 import dotenv from 'dotenv';
 import logger from '@/infrastructure/log/logger';
+import morgan from 'morgan';
 <% if (communication === 'REST APIs') { %>import userRoutes from '@/interfaces/routes/userRoutes';<% } -%>
 <% if (communication === 'REST APIs') { -%>
 import swaggerUi from 'swagger-ui-express';
@@ -24,6 +25,7 @@ const limiter = rateLimit({ windowMs: 10 * 60 * 1000, max: 100 });
 app.use(limiter);
 
 app.use(express.json());
+app.use(morgan('combined', { stream: { write: (message) => logger.info(message.trim()) } }));
 
 <% if (communication === 'REST APIs') { -%>
 app.use('/api/users', userRoutes);
@@ -37,34 +39,37 @@ app.get('/health', (req: Request, res: Response) => {
   res.json({ status: 'UP' });
 });
 
+// Start Server Logic
+const startServer = async () => {
+    logger.info(`Server running on port ${port}`);
+<%_ if (communication === 'Kafka') { -%>
+    try {
+    const kafkaService = new KafkaService();
+    await kafkaService.connect();
+    logger.info('Kafka connected');
+    // Demo
+    await kafkaService.sendMessage('test-topic', 'Hello Kafka from Clean Arch TS!');
+    } catch (err) {
+    logger.error('Failed to connect to Kafka:', err);
+    }
+<%_ } -%>
+};
+
+<%_ if (database !== 'None') { -%>
 // Database Sync
 const syncDatabase = async () => {
     let retries = 30;
     while (retries) {
         try {
-            <% if (database === 'MongoDB') { %>
+            <%_ if (database === 'MongoDB') { -%>
             const connectDB = (await import('@/infrastructure/database/database')).default;
             await connectDB();
-            <% } else { %>
+            <%_ } else { -%>
             const sequelize = (await import('@/infrastructure/database/database')).default;
             await sequelize.sync();
-            <% } %>
+            <%_ } -%>
             logger.info('Database synced');
-            
-            app.listen(port, async () => {
-              logger.info(`Server running on port ${port}`);
-<%_ if (communication === 'Kafka') { -%>
-              try {
-                const kafkaService = new KafkaService();
-                await kafkaService.connect();
-                logger.info('Kafka connected');
-                // Demo
-                await kafkaService.sendMessage('test-topic', 'Hello Kafka from Clean Arch TS!');
-              } catch (err) {
-                logger.error('Failed to connect to Kafka:', err);
-              }
-<%_ } -%>
-            });
+            app.listen(port, startServer);
             break;
         } catch (error) {
             logger.error('Error syncing database:', error);
@@ -75,4 +80,7 @@ const syncDatabase = async () => {
     }
 };
 
-syncDatabase();
+syncDatabase();
+<%_ } else { -%>
+app.listen(port, startServer);
+<%_ } -%>

package/templates/clean-architecture/ts/src/infrastructure/log/logger.ts

@@ -1,4 +1,5 @@
 import winston from 'winston';
+import 'winston-daily-rotate-file';
 
 const logger = winston.createLogger({
   level: 'info',
@@ -8,8 +9,21 @@ const logger = winston.createLogger({
   ),
   defaultMeta: { service: 'user-service' },
   transports: [
-    new winston.transports.File({ filename: 'error.log', level: 'error' }),
-    new winston.transports.File({ filename: 'combined.log' }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/error-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+      level: 'error',
+    }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/combined-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+    }),
   ],
 });
 

package/templates/clean-architecture/ts/src/infrastructure/repositories/userRepository.ts.ejs

@@ -3,25 +3,36 @@ import UserModel from '@/infrastructure/database/models/User';
 
 export class UserRepository {
     async save(user: UserEntity): Promise<UserEntity> {
+<%_ if (database === 'MongoDB') { -%>
         const newUser = await UserModel.create({ name: user.name, email: user.email });
-<% if (database === 'MongoDB') { %>        return { id: newUser._id.toString(), name: newUser.name, email: newUser.email };
-<% } else { %>        return { id: newUser.id, name: newUser.name, email: newUser.email };
-<% } -%>
+        return { id: newUser._id.toString(), name: newUser.name, email: newUser.email };
+<%_ } else if (database === 'None') { -%>
+        const newUser = { id: String(UserModel.mockData.length + 1), name: user.name, email: user.email };
+        UserModel.mockData.push(newUser);
+        return newUser;
+<%_ } else { -%>
+        const newUser = await UserModel.create({ name: user.name, email: user.email });
+        return { id: newUser.id, name: newUser.name, email: newUser.email };
+<%_ } -%>
     }
 
     async getUsers(): Promise<UserEntity[]> {
-<% if (database === 'MongoDB') { %>        const users = await UserModel.find();
+<%_ if (database === 'MongoDB') { -%>
+        const users = await UserModel.find();
         return users.map(user => ({
             id: user._id.toString(),
             name: user.name,
             email: user.email
         }));
-<% } else { %>        const users = await UserModel.findAll();
+<%_ } else if (database === 'None') { -%>
+        return UserModel.mockData;
+<%_ } else { -%>
+        const users = await UserModel.findAll();
         return users.map(user => ({
             id: user.id,
             name: user.name,
             email: user.email
         }));
-<% } -%>
+<%_ } -%>
     }
 }

package/templates/common/Dockerfile

@@ -45,6 +45,9 @@ COPY --from=builder /app/src/views ./dist/views
 
 EXPOSE 3000
 
+# Create logs directory and give permissions to node user
+RUN mkdir -p logs && chown -R node:node logs
+
 USER node
 
 CMD ["npm", "start"]

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

@@ -1,40 +1,54 @@
-version: '3.8'
-
 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:
+<%_ } -%>
+<%_ 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
+<%_ if (database === 'MySQL') { -%>
+      - DB_USER=root
       - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
-<% } %><% if (database === 'PostgreSQL') { %>      - DB_USER=postgres
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      - DB_USER=postgres
       - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
-<% } -%>
-<% } else { %>
+<%_ } -%>
+<%_ } -%>
+<%_ } else { -%>
     environment:
       - PORT=3000
+<%_ if (database !== 'None') { -%>
       - DB_HOST=db
-<% if (database === 'MySQL') { %>      - DB_USER=root
+<%_ if (database === 'MySQL') { -%>
+      - DB_USER=root
       - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
-<% } %><% if (database === 'PostgreSQL') { %>      - DB_USER=postgres
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      - DB_USER=postgres
       - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
-<% } -%>
-<% } %>
+<%_ } -%>
+<%_ } -%>
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
   db:
-<% if (database === 'MySQL') { %>    image: mysql:8.0
+<%_ if (database === 'MySQL') { -%>
+    image: mysql:8.0
     restart: always
     environment:
       MYSQL_ROOT_PASSWORD: root
@@ -43,7 +57,8 @@ services:
       - "${DB_PORT:-3306}:3306"
     volumes:
       - ./flyway/sql:/docker-entrypoint-initdb.d
-<% } else if (database === 'PostgreSQL') { %>    image: postgres:15
+<%_ } else if (database === 'PostgreSQL') { -%>
+    image: postgres:15
     restart: always
     environment:
       POSTGRES_USER: postgres
@@ -53,7 +68,8 @@ services:
       - "${DB_PORT:-5432}:5432"
     volumes:
       - ./flyway/sql:/docker-entrypoint-initdb.d
-<% } else if (database === 'MongoDB') { %>    image: mongo:latest
+<%_ } else if (database === 'MongoDB') { -%>
+    image: mongo:latest
     restart: always
     environment:
       MONGO_INITDB_DATABASE: <%= dbName %>
@@ -73,24 +89,29 @@ services:
       - DB_NAME=<%= dbName %>
     depends_on:
       - db
-<% } %>
-<% if (database !== 'MongoDB') { %>
+<%_ } -%>
+<%_ } -%>
+<%_ 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 %>
+<%_ 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 %>
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      FLYWAY_URL: jdbc:postgresql://db:5432/<%= dbName %>
       FLYWAY_USER: postgres
       FLYWAY_PASSWORD: root
-<% } %>    depends_on:
+<%_ } -%>
+    depends_on:
       - db
-<% } %>
-<% if (communication === 'Kafka') { %>  zookeeper:
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+  zookeeper:
     image: confluentinc/cp-zookeeper:7.4.0
     environment:
       ZOOKEEPER_CLIENT_PORT: 2181
@@ -111,6 +132,8 @@ services:
       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:
+<%_ } -%>

package/templates/common/package.json.ejs

@@ -13,8 +13,10 @@
     "prepare": "husky install",
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
+    "test:coverage": "jest --coverage"
+    <%_ if (database === 'MongoDB') { -%>,
     "migrate": "migrate-mongo up"
+<%_ } -%>
   },
   "dependencies": {
     "express": "^4.18.2",
@@ -38,7 +40,9 @@
     "helmet": "^7.1.0",
     "hpp": "^0.2.3",
     "express-rate-limit": "^7.1.5",
-    "winston": "^3.11.0"<% if (communication === 'REST APIs') { %>,
+    "winston": "^3.11.0",
+    "winston-daily-rotate-file": "^5.0.0",
+    "morgan": "^1.10.0"<% if (communication === 'REST APIs') { %>,
     "swagger-ui-express": "^5.0.0",
     "swagger-jsdoc": "^6.2.8"<% } %>
   },
@@ -53,7 +57,10 @@
     "@types/hpp": "^0.2.3",
 <% if (database === 'PostgreSQL') { %>    "@types/pg": "^8.10.9",
 <% } -%>
+<%_ if (database === 'MySQL' || database === 'PostgreSQL') { -%>
     "@types/sequelize": "^4.28.19",
+<%_ } -%>
+    "@types/morgan": "^1.9.9",
     "rimraf": "^5.0.5"<% if (viewEngine && viewEngine !== 'None') { %>,
     "copyfiles": "^2.4.1"<% } %><% } %>,
     "eslint": "^8.56.0",

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

@@ -4,9 +4,13 @@ const logger = require('../utils/logger');
 
 const getUsers = async (req, res) => {
   try {
-<% if (database === 'MongoDB') { %>    const users = await User.find();
-<% } else { %>    const users = await User.findAll();
-<% } -%>
+<%_ 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) {
     logger.error('Error fetching users:', error);
@@ -17,8 +21,14 @@ const getUsers = async (req, res) => {
 const createUser = async (req, res) => {
   try {
     const { name, email } = req.body;
+<%_ if (database === 'None') { -%>
+    const newUser = { id: String(User.mockData.length + 1), name, email };
+    User.mockData.push(newUser);
+    res.status(HTTP_STATUS.CREATED).json(newUser);
+<%_ } else { -%>
     const user = await User.create({ name, email });
     res.status(HTTP_STATUS.CREATED).json(user);
+<%_ } -%>
   } catch (error) {
     res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: error.message });
   }

package/templates/mvc/js/src/index.js.ejs

@@ -11,9 +11,11 @@ const swaggerSpecs = require('./config/swagger');
 const app = express();
 const PORT = process.env.PORT || 3000;
 const logger = require('./utils/logger');
+const morgan = require('morgan');
 
 app.use(cors());
 app.use(express.json());
+app.use(morgan('combined', { stream: { write: message => logger.info(message.trim()) } }));
 
 <% if (communication === 'REST APIs') { -%>
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
@@ -45,34 +47,38 @@ app.get('/health', (req, res) => {
   res.json({ status: 'UP' });
 });
 
+// Start Server Logic
+const startServer = async () => {
+    logger.info(`Server running on port ${PORT}`);
+<%_ if (communication === 'Kafka') { -%>
+    try {
+      await connectKafka();
+      logger.info('Kafka connected');
+      // Demo: Send a test message
+      await sendMessage('test-topic', 'Hello Kafka from MVC JS!');
+    } catch (err) {
+      logger.error('Failed to connect to Kafka:', err);
+    }
+<%_ } -%>
+};
+
+<%_ if (database !== 'None') { -%>
 // Database Sync
 const syncDatabase = async () => {
     let retries = 30;
     while (retries) {
         try {
-            <% if (database === 'MongoDB') { %>
+            <%_ if (database === 'MongoDB') { -%>
             const connectDB = require('./config/database');
             await connectDB();
-            <% } else { %>
+            <%_ } else { -%>
             const sequelize = require('./config/database');
             await sequelize.sync();
-            <% } %>
+            <%_ } -%>
             logger.info('Database synced');
             
             // Start Server after DB is ready
-            app.listen(PORT, async () => {
-              logger.info(`Server running on port ${PORT}`);
-<%_ if (communication === 'Kafka') { -%>
-              try {
-                await connectKafka();
-                logger.info('Kafka connected');
-                // Demo: Send a test message
-                await sendMessage('test-topic', 'Hello Kafka from MVC JS!');
-              } catch (err) {
-                logger.error('Failed to connect to Kafka:', err);
-              }
-<%_ } -%>
-            });
+            app.listen(PORT, startServer);
             break;
         } catch (err) {
             logger.error('Database sync failed:', err);
@@ -83,4 +89,7 @@ const syncDatabase = async () => {
     }
 };
 
-syncDatabase();
+syncDatabase();
+<%_ } else { -%>
+app.listen(PORT, startServer);
+<%_ } -%>

package/templates/mvc/js/src/utils/logger.js

@@ -1,4 +1,5 @@
 const winston = require('winston');
+require('winston-daily-rotate-file');
 
 const logger = winston.createLogger({
   level: 'info',
@@ -8,12 +9,21 @@ const logger = winston.createLogger({
   ),
   defaultMeta: { service: 'user-service' },
   transports: [
-    //
-    // - Write all logs with importance level of `error` or less to `error.log`
-    // - Write all logs with importance level of `info` or less to `combined.log`
-    //
-    new winston.transports.File({ filename: 'error.log', level: 'error' }),
-    new winston.transports.File({ filename: 'combined.log' }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/error-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+      level: 'error',
+    }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/combined-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+    }),
   ],
 });
 

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

@@ -6,9 +6,13 @@ import logger from '@/utils/logger';
 export class UserController {
     async getUsers(req: Request, res: Response) {
         try {
-<% if (database === 'MongoDB') { %>            const users = await User.find();
-<% } else { %>            const users = await User.findAll();
-<% } -%>
+<%_ 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) {
             logger.error('Error fetching users:', error);
@@ -23,8 +27,14 @@ export class UserController {
     async createUser(req: Request, res: Response) {
         try {
             const { name, email } = req.body;
+<%_ if (database === 'None') { -%>
+            const newUser = { id: String(User.mockData.length + 1), name, email };
+            User.mockData.push(newUser);
+            res.status(HTTP_STATUS.CREATED).json(newUser);
+<%_ } else { -%>
             const user = await User.create({ name, email });
             res.status(HTTP_STATUS.CREATED).json(user);
+<%_ } -%>
         } catch (error) {
             logger.error('Error creating user:', error);
             if (error instanceof Error) {

package/templates/mvc/ts/src/index.ts.ejs

@@ -5,6 +5,7 @@ import hpp from 'hpp';
 import rateLimit from 'express-rate-limit';
 import dotenv from 'dotenv';
 import logger from '@/utils/logger';
+import morgan from 'morgan';
 <% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>import apiRoutes from '@/routes/api';<% } -%>
 <% if (communication === 'REST APIs') { %>
 import swaggerUi from 'swagger-ui-express';
@@ -24,6 +25,7 @@ const limiter = rateLimit({ windowMs: 10 * 60 * 1000, max: 100 });
 app.use(limiter);
 
 app.use(express.json());
+app.use(morgan('combined', { stream: { write: (message) => logger.info(message.trim()) } }));
 
 <% if (communication === 'REST APIs') { -%>
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
@@ -55,34 +57,38 @@ app.get('/health', (req: Request, res: Response) => {
   res.json({ status: 'UP' });
 });
 
+// Start Server Logic
+const startServer = async () => {
+    logger.info(`Server running on port ${port}`);
+<%_ if (communication === 'Kafka') { -%>
+    try {
+      const kafkaService = new KafkaService();
+      await kafkaService.connect();
+      logger.info('Kafka connected');
+      // Demo: Send a test message
+      await kafkaService.sendMessage('test-topic', 'Hello Kafka from MVC TS!');
+    } catch (err) {
+      logger.error('Failed to connect to Kafka:', err);
+    }
+<%_ } -%>
+};
+
+<%_ if (database !== 'None') { -%>
 // Database Sync
 const syncDatabase = async () => {
     let retries = 30;
     while (retries) {
         try {
-            <% if (database === 'MongoDB') { %>
+            <%_ if (database === 'MongoDB') { -%>
             const connectDB = (await import('@/config/database')).default;
             await connectDB();
-            <% } else { %>
+            <%_ } else { -%>
             const sequelize = (await import('@/config/database')).default;
             await sequelize.sync();
-            <% } %>
+            <%_ } -%>
             logger.info('Database synced');
             // Start Server after DB is ready
-            app.listen(port, async () => {
-              logger.info(`Server running on port ${port}`);
-<%_ if (communication === 'Kafka') { -%>
-              try {
-                const kafkaService = new KafkaService();
-                await kafkaService.connect();
-                logger.info('Kafka connected');
-                // Demo: Send a test message
-                await kafkaService.sendMessage('test-topic', 'Hello Kafka from MVC TS!');
-              } catch (err) {
-                logger.error('Failed to connect to Kafka:', err);
-              }
-<%_ } -%>
-            });
+            app.listen(port, startServer);
             break;
         } catch (error) {
             logger.error('Error syncing database:', error);
@@ -93,4 +99,7 @@ const syncDatabase = async () => {
     }
 };
 
-syncDatabase();
+syncDatabase();
+<%_ } else { -%>
+app.listen(port, startServer);
+<%_ } -%>

package/templates/mvc/ts/src/utils/logger.ts

@@ -1,4 +1,5 @@
 import winston from 'winston';
+import 'winston-daily-rotate-file';
 
 const logger = winston.createLogger({
   level: 'info',
@@ -8,8 +9,21 @@ const logger = winston.createLogger({
   ),
   defaultMeta: { service: 'user-service' },
   transports: [
-    new winston.transports.File({ filename: 'error.log', level: 'error' }),
-    new winston.transports.File({ filename: 'combined.log' }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/error-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+      level: 'error',
+    }),
+    new winston.transports.DailyRotateFile({
+      filename: 'logs/combined-%DATE%.log',
+      datePattern: 'YYYY-MM-DD',
+      zippedArchive: true,
+      maxSize: '20m',
+      maxFiles: '14d',
+    }),
   ],
 });
 

package/templates/mvc/js/src/config/database.js

@@ -1,12 +0,0 @@
-// Database configuration placeholder
-// Use environment variables from .env depending on your DB choice (MySQL/Postgres)
-require('dotenv').config();
-
-const dbConfig = {
-    host: process.env.DB_HOST,
-    user: process.env.DB_USER,
-    password: process.env.DB_PASSWORD,
-    database: process.env.DB_NAME
-};
-
-module.exports = dbConfig;