nodejs-quickstart-structure 1.3.5 → 1.4.1

package/templates/common/database/js/models/User.js.mongoose.ejs

@@ -0,0 +1,19 @@
+const mongoose = require('mongoose');
+
+const UserSchema = new mongoose.Schema({
+    name: {
+        type: String,
+        required: true
+    },
+    email: {
+        type: String,
+        required: true,
+        unique: true
+    },
+    createdAt: {
+        type: Date,
+        default: Date.now
+    }
+});
+
+module.exports = mongoose.model('User', UserSchema);

package/templates/common/database/js/mongoose.js.ejs

@@ -0,0 +1,32 @@
+const mongoose = require('mongoose');
+
+let logger;
+<% if (architecture === 'MVC') { %>
+logger = require('../utils/logger');
+<% } else { %>
+logger = require('../log/logger');
+<% } %>
+
+const connectDB = async () => {
+    const dbHost = process.env.DB_HOST || 'localhost';
+    const mongoURI = process.env.MONGO_URI || `mongodb://${dbHost}:27017/<%= dbName %>`;
+    
+    let retries = 5;
+    while (retries) {
+        try {
+            await mongoose.connect(mongoURI, {
+                useNewUrlParser: true,
+                useUnifiedTopology: true
+            });
+            logger.info('MongoDB Connected...');
+            break;
+        } catch (err) {
+            logger.error('MongoDB connection failed:', err);
+            retries -= 1;
+            logger.info(`Retries left: ${retries}. Waiting 5s...`);
+            await new Promise(res => setTimeout(res, 5000));
+        }
+    }
+};
+
+module.exports = connectDB; // Export function to call in index.js

package/templates/common/database/ts/models/User.ts.ejs

@@ -1,5 +1,5 @@
 import { DataTypes, Model } from 'sequelize';
-<% if (architecture === 'MVC') { %>import sequelize from '../config/database';<% } else { %>import sequelize from '../database';<% } %>
+<% if (architecture === 'MVC') { %>import sequelize from '@/config/database';<% } else { %>import sequelize from '@/infrastructure/database/database';<% } %>
 
 class User extends Model {
   public id!: number;

package/templates/common/database/ts/models/User.ts.mongoose.ejs

@@ -0,0 +1,25 @@
+import mongoose, { Schema, Document } from 'mongoose';
+
+export interface IUser extends Document {
+    name: string;
+    email: string;
+    createdAt: Date;
+}
+
+const UserSchema: Schema = new Schema({
+    name: {
+        type: String,
+        required: true
+    },
+    email: {
+        type: String,
+        required: true,
+        unique: true
+    },
+    createdAt: {
+        type: Date,
+        default: Date.now
+    }
+});
+
+export default mongoose.model<IUser>('User', UserSchema);

package/templates/common/database/ts/mongoose.ts.ejs

@@ -0,0 +1,27 @@
+import mongoose from 'mongoose';
+<% if (architecture === 'MVC') { %>
+import logger from '@/utils/logger';
+<% } else { %>
+import logger from '@/infrastructure/log/logger';
+<% } %>
+
+const connectDB = async (): Promise<void> => {
+    const dbHost = process.env.DB_HOST || 'localhost';
+    const mongoURI = process.env.MONGO_URI || `mongodb://${dbHost}:27017/<%= dbName %>`;
+    
+    let retries = 5;
+    while (retries) {
+        try {
+            await mongoose.connect(mongoURI);
+            logger.info('MongoDB Connected...');
+            break;
+        } catch (err) {
+            logger.error('MongoDB connection failed:', err);
+            retries -= 1;
+            logger.info(`Retries left: ${retries}. Waiting 5s...`);
+            await new Promise(res => setTimeout(res, 5000));
+        }
+    }
+};
+
+export default connectDB;

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

@@ -18,7 +18,7 @@ services:
       - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
 <% } %><% if (database === 'PostgreSQL') { %>      - DB_USER=postgres
-      - DB_PASSWORD=postgres
+      - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
 <% } -%>
 <% } else { %>
@@ -29,30 +29,52 @@ services:
       - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
 <% } %><% if (database === 'PostgreSQL') { %>      - DB_USER=postgres
-      - DB_PASSWORD=postgres
+      - DB_PASSWORD=root
       - DB_NAME=<%= dbName %>
 <% } -%>
 <% } %>
   db:
 <% if (database === 'MySQL') { %>    image: mysql:8.0
-    command: --default-authentication-plugin=mysql_native_password
     restart: always
     environment:
       MYSQL_ROOT_PASSWORD: root
       MYSQL_DATABASE: <%= dbName %>
     ports:
       - "${DB_PORT:-3306}:3306"
-<% } %><% if (database === 'PostgreSQL') { %>    image: postgres:15
+    volumes:
+      - ./flyway/sql:/docker-entrypoint-initdb.d
+<% } else if (database === 'PostgreSQL') { %>    image: postgres:15
     restart: always
     environment:
       POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: postgres
+      POSTGRES_PASSWORD: root
       POSTGRES_DB: <%= dbName %>
     ports:
       - "${DB_PORT:-5432}:5432"
-<% } %>    volumes:
-      - <%= database.toLowerCase() %>_data:/var/lib/<% if (database === 'MySQL') { %>mysql<% } else { %>postgresql/data<% } %>
+    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') { %>
   flyway:
     image: flyway/flyway
     command: -connectRetries=60 migrate
@@ -64,9 +86,10 @@ services:
       FLYWAY_PASSWORD: root
 <% } %><% if (database === 'PostgreSQL') { %>      FLYWAY_URL: jdbc:postgresql://db:5432/<%= dbName %>
       FLYWAY_USER: postgres
-      FLYWAY_PASSWORD: postgres
+      FLYWAY_PASSWORD: root
 <% } %>    depends_on:
       - db
+<% } %>
 <% if (communication === 'Kafka') { %>  zookeeper:
     image: confluentinc/cp-zookeeper:7.4.0
     environment:

package/templates/common/jest.config.js.ejs

@@ -3,7 +3,10 @@ module.exports = {
   coverageDirectory: 'coverage',
   collectCoverageFrom: ['src/**/*.{js,ts}'],
   testMatch: ['**/*.test.ts', '**/*.test.js'],
-  <% if (language === 'TypeScript') { %>preset: 'ts-jest',<% } %>
+  <% if (language === 'TypeScript') { %>preset: 'ts-jest',
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+  },<% } %>
   coveragePathIgnorePatterns: [
     "/node_modules/",
     "/dist/"

package/templates/common/kafka/ts/services/kafkaService.ts.ejs

@@ -1,4 +1,4 @@
-import { kafka } from '../config/kafka';
+import { kafka } from '<%= configPath %>';
 import { EachMessagePayload, Producer, Consumer } from 'kafkajs';
 import logger from '<%= loggerPath %>';
 

package/templates/common/migrate-mongo-config.js.ejs

@@ -0,0 +1,31 @@
+const config = {
+  mongodb: {
+    url: process.env.MONGO_URI || `mongodb://${process.env.DB_HOST || 'localhost'}:27017`,
+    databaseName: process.env.DB_NAME || '<%= dbName %>',
+
+    options: {
+      // useNewUrlParser: true, // No longer needed in Node.js driver v4+
+      // useUnifiedTopology: true, // No longer needed in Node.js driver v4+
+      // connectTimeoutMS: 3600000, // increase connection timeout to 1 hour
+      // socketTimeoutMS: 3600000, // increase socket timeout to 1 hour
+    }
+  },
+
+  // The migrations dir, can be an relative or absolute path. Only edit this when really necessary.
+  migrationsDir: "migrations",
+
+  // The mongodb collection where the applied changes are stored. Only edit this when really necessary.
+  changelogCollectionName: "changelog",
+
+  // The file extension to create migrations and search for in migration dir 
+  migrationFileExtension: ".js",
+
+  // Enable the algorithm to create a checksum of the file contents and use that in the comparison to determine
+  // if the file should be run.  Requires that scripts are coded to be run multiple times.
+  useFileHash: false,
+
+  // Don't change this, unless you know what you are doing
+  moduleSystem: 'commonjs',
+};
+
+module.exports = config;

package/templates/common/migrations/init.js.ejs

@@ -0,0 +1,23 @@
+module.exports = {
+  async up(db, client) {
+    const adminEmail = 'admin@example.com';
+    const existingAdmin = await db.collection('users').findOne({ email: adminEmail });
+
+    if (!existingAdmin) {
+      await db.collection('users').insertOne({
+        name: 'Admin User',
+        email: adminEmail,
+        createdAt: new Date(),
+        updatedAt: new Date()
+      });
+      console.log('Admin User seeded successfully');
+    } else {
+      console.log('Admin User already exists, skipping seed');
+    }
+  },
+
+  async down(db, client) {
+    // Optional: Undo the seed. Usually for seeds we might want to keep data, but strictly speaking 'down' should reverse 'up'.
+    // await db.collection('users').deleteOne({ email: 'admin@example.com' });
+  }
+};

package/templates/common/package.json.ejs

@@ -5,24 +5,29 @@
   "main": "<% if (language === 'TypeScript') { %>dist/index.js<% } else { %>src/index.js<% } %>",
   "scripts": {
     "start": "<% if (language === 'TypeScript') { %>node dist/index.js<% } else { %>node src/index.js<% } %>",
-    "dev": "<% if (language === 'TypeScript') { %>nodemon --exec ts-node src/index.ts<% } else { %>nodemon src/index.js<% } %>"<% if (language === 'TypeScript') { %>,
-    "build": "rimraf dist && tsc<% if (viewEngine && viewEngine !== 'None') { %> && copyfiles -u 1 \"src/views/**/*\" dist/<% } %>"<% } %>,
+    "dev": "<% if (language === 'TypeScript') { %>nodemon --exec ts-node -r tsconfig-paths/register src/index.ts<% } else { %>nodemon src/index.js<% } %>"<% if (language === 'TypeScript') { %>,
+    "build": "rimraf dist && tsc && tsc-alias<% if (viewEngine && viewEngine !== 'None') { %> && copyfiles -u 1 \"src/views/**/*\" dist/<% } %>"<% } %>,
     "lint": "eslint . --ext .ts,.js",
     "lint:fix": "eslint . --ext .ts,.js --fix",
     "format": "prettier --write .",
     "prepare": "husky install",
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage"
+    "test:coverage": "jest --coverage",
+    "migrate": "migrate-mongo up"
   },
   "dependencies": {
     "express": "^4.18.2",
     "dotenv": "^16.3.1",
 <% if (database === 'MySQL') { %>    "mysql2": "^3.6.5",
+    "sequelize": "^6.35.2",
 <% } -%>
 <% if (database === 'PostgreSQL') { %>    "pg": "^8.11.3",
-<% } -%>
     "sequelize": "^6.35.2",
+<% } -%>
+<% if (database === 'MongoDB') { %>    "mongoose": "^8.0.3",
+    "migrate-mongo": "^11.0.0",
+<% } -%>
 <% if (communication === 'Kafka') { %>    "kafkajs": "^2.2.4",
 <% } -%>
 <% if (viewEngine === 'EJS') { %>    "ejs": "^3.1.9",
@@ -35,8 +40,7 @@
     "express-rate-limit": "^7.1.5",
     "winston": "^3.11.0"<% if (communication === 'REST APIs') { %>,
     "swagger-ui-express": "^5.0.0",
-    "swagger-jsdoc": "^6.2.8"
-<% } %>
+    "swagger-jsdoc": "^6.2.8"<% } %>
   },
   "devDependencies": {
     "nodemon": "^3.0.2"<% if (language === 'TypeScript') { %>,
@@ -65,6 +69,8 @@
     "ts-jest": "^29.1.1",
     "@types/jest": "^29.5.11",
     "supertest": "^6.3.3",
+    "tsconfig-paths": "^4.2.0",
+    "tsc-alias": "^1.8.8",
     "@types/supertest": "^6.0.2"<% } else { %>,
     "jest": "^29.7.0",
     "supertest": "^6.3.3"<% } %>

package/templates/common/public/css/style.css

@@ -0,0 +1,147 @@
+:root {
+  --primary-color: #4f46e5;
+  --primary-hover: #4338ca;
+  --bg-color: #f9fafb;
+  --card-bg: #ffffff;
+  --text-main: #111827;
+  --text-muted: #6b7280;
+  --success-color: #10b981;
+  --border-color: #e5e7eb;
+  --shadow-sm: 0 1px 2px 0 rgba(0, 0, 0, 0.05);
+  --shadow-md: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
+}
+
+body {
+  font-family: 'Inter', system-ui, -apple-system, sans-serif;
+  background-color: var(--bg-color);
+  color: var(--text-main);
+  margin: 0;
+  padding: 0;
+  line-height: 1.5;
+  display: flex;
+  justify-content: center;
+  min-height: 100vh;
+}
+
+.container {
+  width: 100%;
+  max-width: 800px;
+  padding: 40px 20px;
+}
+
+.header {
+  text-align: center;
+  margin-bottom: 40px;
+}
+
+.logo {
+  font-size: 3rem;
+  margin-bottom: 10px;
+}
+
+h1 {
+  font-size: 2.5rem;
+  font-weight: 800;
+  color: var(--text-main);
+  margin: 0 0 10px 0;
+  letter-spacing: -0.025em;
+}
+
+.subtitle {
+  color: var(--text-muted);
+  font-size: 1.125rem;
+}
+
+.card-grid {
+  display: grid;
+  grid-template-columns: repeat(auto-fit, minmax(240px, 1fr));
+  gap: 20px;
+  margin-bottom: 40px;
+}
+
+.card {
+  background: var(--card-bg);
+  padding: 24px;
+  border-radius: 12px;
+  box-shadow: var(--shadow-sm);
+  border: 1px solid var(--border-color);
+  transition: transform 0.2s, box-shadow 0.2s;
+}
+
+.card:hover {
+  transform: translateY(-2px);
+  box-shadow: var(--shadow-md);
+}
+
+.card h3 {
+  margin-top: 0;
+  font-size: 0.875rem;
+  text-transform: uppercase;
+  letter-spacing: 0.05em;
+  color: var(--text-muted);
+  font-weight: 600;
+}
+
+.card p {
+  font-size: 1.25rem;
+  font-weight: 600;
+  color: var(--text-main);
+  margin: 5px 0 0 0;
+}
+
+.status-card {
+  background: var(--card-bg);
+  border-radius: 12px;
+  padding: 24px;
+  box-shadow: var(--shadow-md);
+  border-left: 6px solid var(--success-color);
+  display: flex;
+  align-items: center;
+  gap: 20px;
+}
+
+.status-icon {
+  background: #d1fae5;
+  color: var(--success-color);
+  width: 48px;
+  height: 48px;
+  border-radius: 50%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  font-size: 1.5rem;
+}
+
+.status-content h3 {
+  margin: 0;
+  font-size: 1.25rem;
+  font-weight: 700;
+}
+
+.status-content p {
+  margin: 5px 0 0 0;
+  color: var(--text-muted);
+}
+
+.action-btn {
+  display: inline-block;
+  margin-top: 40px;
+  background-color: var(--primary-color);
+  color: white;
+  padding: 12px 24px;
+  border-radius: 8px;
+  text-decoration: none;
+  font-weight: 600;
+  transition: background-color 0.2s;
+}
+
+.action-btn:hover {
+  background-color: var(--primary-hover);
+}
+
+footer {
+  margin-top: 60px;
+  text-align: center;
+  color: var(--text-muted);
+  font-size: 0.875rem;
+}

package/templates/common/tsconfig.json

@@ -7,7 +7,11 @@
         "strict": true,
         "esModuleInterop": true,
         "skipLibCheck": true,
-        "forceConsistentCasingInFileNames": true
+        "forceConsistentCasingInFileNames": true,
+        "baseUrl": ".",
+        "paths": {
+            "@/*": ["src/*"]
+        }
     },
     "include": [
         "src/**/*"

package/templates/common/views/ejs/index.ejs

@@ -4,28 +4,52 @@
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title><%= projectName %></title>
-    <style>
-        body { font-family: sans-serif; padding: 20px; }
-        h1 { color: #333; }
-        .status { margin-top: 20px; padding: 10px; background: #e0f7fa; border-left: 5px solid #00acc1; }
-    </style>
+    <link rel="stylesheet" href="/css/style.css">
 </head>
 <body>
-    <h1>Welcome to <%= projectName %></h1>
-    <p>Architecture: <strong><%= architecture %></strong></p>
-    <p>Database: <strong><%= database %></strong></p>
-    
-    <% if (communication === 'Kafka') { %>
-    <div class="status">
-        <h3>Kafka Status</h3>
-        <p>Connected to Kafka Broker.</p>
-        <p>Check console for messages.</p>
+    <div class="container">
+        <header class="header">
+            <div class="logo">🚀</div>
+            <h1>Welcome to <%= projectName %></h1>
+            <p class="subtitle">A production-ready Node.js microservice starter.</p>
+        </header>
+
+        <div class="card-grid">
+            <div class="card">
+                <h3>Architecture</h3>
+                <p><%= architecture %></p>
+            </div>
+            <div class="card">
+                <h3>Database</h3>
+                <p><%= database %></p>
+            </div>
+            <div class="card">
+                <h3>Communication</h3>
+                <p><%= communication %></p>
+            </div>
+        </div>
+
+        <% if (communication === 'Kafka') { %>
+        <div class="status-card">
+            <div class="status-icon">🔄</div>
+            <div class="status-content">
+                <h3>Kafka Connected</h3>
+                <p>Connection to broker established successfully.</p>
+            </div>
+        </div>
+        <% } else { %>
+        <div class="status-card">
+            <div class="status-icon">✅</div>
+            <div class="status-content">
+                <h3>API Active</h3>
+                <p>REST API is running and ready to accept requests.</p>
+            </div>
+        </div>
+        <% } %>
+
+        <footer>
+            <p>Generated with ❤️ by Node.js Quickstart Generator</p>
+        </footer>
     </div>
-    <% } else { %>
-    <div class="status">
-        <h3>API Status</h3>
-        <p>REST API is active.</p>
-    </div>
-    <% } %>
 </body>
 </html>

package/templates/common/views/pug/index.pug

@@ -4,23 +4,37 @@ html(lang="en")
     meta(charset="UTF-8")
     meta(name="viewport", content="width=device-width, initial-scale=1.0")
     title= projectName
-    style.
-      body { font-family: sans-serif; padding: 20px; }
-      h1 { color: #333; }
-      .status { margin-top: 20px; padding: 10px; background: #e0f7fa; border-left: 5px solid #00acc1; }
+    link(rel="stylesheet", href="/css/style.css")
   body
-    h1 Welcome to #{projectName}
-    p Architecture: 
-      strong #{architecture}
-    p Database: 
-      strong #{database}
+    .container
+      header.header
+        .logo 🚀
+        h1 Welcome to #{projectName}
+        p.subtitle A production-ready Node.js microservice starter.
 
-    if communication === 'Kafka'
-      .status
-        h3 Kafka Status
-        p Connected to Kafka Broker.
-        p Check console for messages.
-    else
-      .status
-        h3 API Status
-        p REST API is active.
+      .card-grid
+        .card
+          h3 Architecture
+          p #{architecture}
+        .card
+          h3 Database
+          p #{database}
+        .card
+          h3 Communication
+          p #{communication}
+
+      if communication === 'Kafka'
+        .status-card
+          .status-icon 🔄
+          .status-content
+            h3 Kafka Connected
+            p Connection to broker established successfully.
+      else 
+        .status-card
+          .status-icon ✅
+          .status-content
+            h3 API Active
+            p REST API is running and ready to accept requests.
+
+      footer
+        p Generated with ❤️ by Node.js Quickstart Generator

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

@@ -4,7 +4,9 @@ const logger = require('../utils/logger');
 
 const getUsers = async (req, res) => {
   try {
-    const users = await User.findAll();
+<% if (database === 'MongoDB') { %>    const users = await User.find();
+<% } else { %>    const users = await User.findAll();
+<% } -%>
     res.json(users);
   } catch (error) {
     logger.error('Error fetching users:', error);

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

@@ -24,7 +24,7 @@ app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
 const path = require('path');
 app.set('views', path.join(__dirname, 'views'));
 app.set('view engine', '<%= viewEngine.toLowerCase() %>');
-<% } -%>
+app.use(express.static(path.join(__dirname, '../public')));<% } -%>
 
 // Routes
 <% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { -%>
@@ -50,8 +50,13 @@ const syncDatabase = async () => {
     let retries = 30;
     while (retries) {
         try {
+            <% if (database === 'MongoDB') { %>
+            const connectDB = require('./config/database');
+            await connectDB();
+            <% } else { %>
             const sequelize = require('./config/database');
             await sequelize.sync();
+            <% } %>
             logger.info('Database synced');
             
             // Start Server after DB is ready

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

@@ -1,12 +1,14 @@
 import { Request, Response } from 'express';
-import User from '../models/User';
-import { HTTP_STATUS } from '../utils/httpCodes';
-import logger from '../utils/logger';
+import User from '@/models/User';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+import logger from '@/utils/logger';
 
 export class UserController {
     async getUsers(req: Request, res: Response) {
         try {
-            const users = await User.findAll();
+<% if (database === 'MongoDB') { %>            const users = await User.find();
+<% } else { %>            const users = await User.findAll();
+<% } -%>
             res.json(users);
         } catch (error) {
             logger.error('Error fetching users:', error);