nodejs-quickstart-structure 1.3.5 → 1.3.9

package/lib/generator.js

@@ -131,15 +131,15 @@ export const generateProject = async (config) => {
         const kafkaServiceTemplate = path.join(targetDir, 'src', 'services', `${kafkaServiceFileName}.ejs`);
         
         if (await fs.pathExists(kafkaServiceTemplate)) {
-            const loggerPath = architecture === 'Clean Architecture' ? '../log/logger' : '../utils/logger';
-            // Note: For MVC, it's relative to src/services (../utils/logger). Wait, ../utils/logger means src/utils/logger.
-            // src/services/kafka.ts -> ../utils/logger -> src/utils/logger. Correct.
-            // But wait, generated code for MVC usually puts it in src/services.
-            // Let's re-verify MVC structure for logger.
-            // In MVC, logger is usually in src/utils/logger.ts?
-            // Let's check where logger is copied for MVC.
+            let loggerPath = architecture === 'Clean Architecture' ? '../log/logger' : '../utils/logger';
+            let configPath = '../config/kafka';
+
+            if (language === 'TypeScript') {
+                loggerPath = architecture === 'Clean Architecture' ? '@/infrastructure/log/logger' : '@/utils/logger';
+                configPath = architecture === 'Clean Architecture' ? '@/infrastructure/config/kafka' : '@/config/kafka';
+            }
             
-            const content = ejs.render(await fs.readFile(kafkaServiceTemplate, 'utf-8'), { loggerPath });
+            const content = ejs.render(await fs.readFile(kafkaServiceTemplate, 'utf-8'), { loggerPath, configPath });
             await fs.writeFile(path.join(targetDir, 'src', 'services', kafkaServiceFileName), content);
             await fs.remove(kafkaServiceTemplate);
         }
@@ -252,6 +252,10 @@ export const generateProject = async (config) => {
 
     // 8. View Engine (MVC)
     if (architecture === 'MVC' && viewEngine && viewEngine !== 'None') {
+        const publicDir = path.join(templatesDir, 'common', 'public');
+        if (await fs.pathExists(publicDir)) {
+            await fs.copy(publicDir, path.join(targetDir, 'public'));
+        }
     }
 
     // 9. Render Swagger Config (if .ejs exists)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodejs-quickstart-structure",
-  "version": "1.3.5",
+  "version": "1.3.9",
   "type": "module",
   "description": "A CLI to scaffold Node.js microservices with MVC or Clean Architecture",
   "main": "bin/index.js",

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

@@ -4,12 +4,12 @@ import helmet from 'helmet';
 import hpp from 'hpp';
 import rateLimit from 'express-rate-limit';
 import dotenv from 'dotenv';
-import logger from './infrastructure/log/logger';
-<% if (communication === 'REST APIs') { %>import userRoutes from './interfaces/routes/userRoutes';<% } -%>
+import logger from '@/infrastructure/log/logger';
+<% if (communication === 'REST APIs') { %>import userRoutes from '@/interfaces/routes/userRoutes';<% } -%>
 <% if (communication === 'REST APIs') { -%>
 import swaggerUi from 'swagger-ui-express';
-import swaggerSpecs from './config/swagger';<% } -%>
-<% if (communication === 'Kafka') { %>import { KafkaService } from './infrastructure/messaging/kafkaClient';<% } -%>
+import swaggerSpecs from '@/config/swagger';<% } -%>
+<% if (communication === 'Kafka') { %>import { KafkaService } from '@/infrastructure/messaging/kafkaClient';<% } -%>
 
 dotenv.config();
 
@@ -42,7 +42,7 @@ const syncDatabase = async () => {
     let retries = 30;
     while (retries) {
         try {
-            const sequelize = (await import('./infrastructure/database/database')).default;
+            const sequelize = (await import('@/infrastructure/database/database')).default;
             await sequelize.sync();
             logger.info('Database synced');
             

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

@@ -1,5 +1,5 @@
-import { User as UserEntity } from '../../domain/user';
-import UserModel from '../database/models/User';
+import { User as UserEntity } from '@/domain/user';
+import UserModel from '@/infrastructure/database/models/User';
 
 export class UserRepository {
     async save(user: UserEntity): Promise<UserEntity> {

package/templates/clean-architecture/ts/src/interfaces/controllers/userController.ts

@@ -1,9 +1,9 @@
 import { Request, Response } from 'express';
-import { UserRepository } from '../../infrastructure/repositories/UserRepository';
-import CreateUser from '../../usecases/createUser';
-import GetAllUsers from '../../usecases/getAllUsers';
-import { HTTP_STATUS } from '../../utils/httpCodes';
-import logger from '../../infrastructure/log/logger';
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+import CreateUser from '@/usecases/createUser';
+import GetAllUsers from '@/usecases/getAllUsers';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+import logger from '@/infrastructure/log/logger';
 
 export class UserController {
     private createUserUseCase: CreateUser;

package/templates/clean-architecture/ts/src/interfaces/routes/userRoutes.ts

@@ -1,5 +1,5 @@
 import { Router, Request, Response } from 'express';
-import { UserController } from '../controllers/userController';
+import { UserController } from '@/interfaces/controllers/userController';
 
 const router = Router();
 const userController = new UserController();

package/templates/clean-architecture/ts/src/usecases/createUser.ts

@@ -1,6 +1,6 @@
-import { User } from '../domain/user';
+import { User } from '@/domain/user';
 
-import { UserRepository } from '../infrastructure/repositories/UserRepository';
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
 
 export default class CreateUser {
     constructor(private userRepository: UserRepository) {}

package/templates/clean-architecture/ts/src/usecases/getAllUsers.ts

@@ -1,4 +1,4 @@
-import { UserRepository } from '../infrastructure/repositories/UserRepository';
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
 
 export default class GetAllUsers {
     constructor(private userRepository: UserRepository) {}

package/templates/common/Dockerfile

@@ -40,6 +40,7 @@ COPY --from=builder /app/src ./src
 # Copy other necessary files (like views if MVC)
 <% if (viewEngine && viewEngine !== 'None') { %>
 COPY --from=builder /app/src/views ./dist/views
+<% if (viewEngine && viewEngine !== 'None') { %>COPY --from=builder /app/public ./public<% } %>
 <% } %>
 
 EXPOSE 3000

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/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/package.json.ejs

@@ -5,8 +5,8 @@
   "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 .",
@@ -65,6 +65,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/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')) { -%>

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

@@ -1,7 +1,7 @@
 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) {

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

@@ -4,12 +4,12 @@ import helmet from 'helmet';
 import hpp from 'hpp';
 import rateLimit from 'express-rate-limit';
 import dotenv from 'dotenv';
-import logger from './utils/logger';
-<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>import apiRoutes from './routes/api';<% } -%>
+import logger from '@/utils/logger';
+<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>import apiRoutes from '@/routes/api';<% } -%>
 <% if (communication === 'REST APIs') { %>
 import swaggerUi from 'swagger-ui-express';
-import swaggerSpecs from './config/swagger';<% } -%>
-<% if (communication === 'Kafka') { %>import { KafkaService } from './services/kafkaService';<% } -%>
+import swaggerSpecs from '@/config/swagger';<% } -%>
+<% if (communication === 'Kafka') { %>import { KafkaService } from '@/services/kafkaService';<% } -%>
 
 dotenv.config();
 
@@ -34,7 +34,7 @@ app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
 import path from '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')) { -%>
@@ -60,7 +60,7 @@ const syncDatabase = async () => {
     let retries = 30;
     while (retries) {
         try {
-            const sequelize = (await import('./config/database')).default;
+            const sequelize = (await import('@/config/database')).default;
             await sequelize.sync();
             logger.info('Database synced');
             

package/templates/mvc/ts/src/routes/api.ts

@@ -1,5 +1,5 @@
 import { Router, Request, Response } from 'express';
-import { UserController } from '../controllers/userController';
+import { UserController } from '@/controllers/userController';
 
 const router = Router();
 const userController = new UserController();