create-lumina-project 1.0.0

package/template/src/utils/Logger.ts

@@ -0,0 +1,79 @@
+import winston from 'winston';
+import path from 'path';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+class Logger {
+  private logger: winston.Logger;
+
+  constructor() {
+    // Define the custom format (Timestamp + Level + Message)
+    const logFormat = winston.format.printf(({ level, message, timestamp }) => {
+      return `${timestamp} [${level}]: ${message}`;
+    });
+
+    this.logger = winston.createLogger({
+      level: process.env.LOG_LEVEL || 'info',
+      format: winston.format.combine(
+        winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+        winston.format.errors({ stack: true }),
+        winston.format.splat(),
+        logFormat
+      ),
+      transports: [
+        // 1. Write all logs with level 'error' and below to error.log
+        new winston.transports.File({ 
+          filename: path.join(process.cwd(), 'logs', 'error.log'), 
+          level: 'error' 
+        }),
+        // 2. Write all logs to combined.log
+        new winston.transports.File({ 
+          filename: path.join(process.cwd(), 'logs', 'combined.log') 
+        }),
+      ],
+    });
+
+    // If we're not in production, log to the console with colors
+    if (process.env.NODE_ENV !== 'production') {
+      this.logger.add(
+        new winston.transports.Console({
+          format: winston.format.combine(
+            winston.format.colorize(),
+            winston.format.simple()
+          ),
+        })
+      );
+    }
+  }
+
+  /**
+   * Log an info message.
+   */
+  public info(message: string, meta?: any): void {
+    this.logger.info(message, meta);
+  }
+
+  /**
+   * Log an error message.
+   */
+  public error(message: string, meta?: any): void {
+    this.logger.error(message, meta);
+  }
+
+  /**
+   * Log a warning message.
+   */
+  public warn(message: string, meta?: any): void {
+    this.logger.warn(message, meta);
+  }
+
+  /**
+   * Log a debug message.
+   */
+  public debug(message: string, meta?: any): void {
+    this.logger.debug(message, meta);
+  }
+}
+
+export default new Logger();

package/template/src/utils/Paginator.ts

@@ -0,0 +1,41 @@
+import { Model, ModelStatic, FindOptions } from 'sequelize';
+import { PaginatedResult } from '../types/Pagination.js';
+
+class Paginator {
+  /**
+   * Paginate a Sequelize Model.
+   * * @param model The Sequelize Model class (e.g., User)
+   * @param page The current page number (default: 1)
+   * @param limit The number of items per page (default: 15)
+   * @param options Additional Sequelize query options (where, include, order)
+   */
+  public async paginate<T extends Model>(
+    model: ModelStatic<T>,
+    page: number = 1,
+    limit: number = 15,
+    options: FindOptions = {}
+  ): Promise<PaginatedResult<T>> {
+    const offset = (page - 1) * limit;
+
+    // Sequelize's findAndCountAll is perfect for pagination
+    const { count, rows } = await model.findAndCountAll({
+      ...options,
+      limit,
+      offset,
+    });
+
+    return {
+      data: rows,
+      meta: {
+        total: count,
+        per_page: limit,
+        current_page: page,
+        last_page: Math.ceil(count / limit),
+        from: offset + 1,
+        to: offset + rows.length,
+      },
+    };
+  }
+}
+
+export default new Paginator();

package/template/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    /* Base Options */
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "typeRoots": ["./src/types", "./node_modules/@types"],
+
+    /* Output Options */
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "removeComments": true,
+    
+    /* Experimental Options (Helpful for Decorators if you use them later) */
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}

package/template/views/maintenance.html

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Lumina - Under Maintenance</title>
+    <style>
+        body {
+            font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
+            background-color: #f3f4f6;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            height: 100vh;
+            margin: 0;
+            color: #374151;
+        }
+        .container {
+            text-align: center;
+            background: white;
+            padding: 3rem;
+            border-radius: 1rem;
+            box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1);
+            max-width: 500px;
+        }
+        h1 { font-size: 2.5rem; margin-bottom: 1rem; color: #111827; }
+        p { font-size: 1.125rem; color: #6b7280; margin-bottom: 2rem; }
+        .icon { font-size: 4rem; margin-bottom: 1rem; }
+        small {
+          color: red;
+        }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <div class="icon">🛠️</div>
+        <h1>We'll be back soon!</h1>
+        <p>Our system is currently undergoing scheduled maintenance to improve your experience. Please check back in a few minutes.</p>
+        <small>Error: 503 Service Unavailable</small>
+    </div>
+</body>
+</html>

package/template/views/welcome.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Lumina</title>
+    <link rel="shortcut icon" href="/img/logo2.png" type="image/x-icon">
+    <style>
+        body {
+            font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+            background-color: #f3f4f6;
+            color: #1f2937;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            height: 100vh;
+            margin: 0;
+        }
+        .container {
+            text-align: center;
+            background: white;
+            padding: 3rem;
+            border-radius: 1rem;
+            box-shadow: 0 10px 15px -3px rgba(0, 0, 0, 0.1);
+            max-width: 500px;
+        }
+        img {
+            width: 100px;
+            height: 100px;
+            border-radius: 20px;
+        }
+        h1 { margin-bottom: 0.5rem; color: #4f46e5; }
+        p { color: #6b7280; margin-bottom: 2rem; }
+        .status {
+            display: inline-block;
+            padding: 0.5rem 1rem;
+            background-color: #d1fae5;
+            color: #065f46;
+            border-radius: 9999px;
+            font-size: 0.875rem;
+            font-weight: 600;
+        }
+        .links { margin-top: 2rem; }
+        a { color: #4f46e5; text-decoration: none; margin: 0 10px; font-weight: 500; }
+        a:hover { text-decoration: underline; }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <img src="/img/logo2.png" alt="Lumina Logo" class="logo">
+        <h1>Lumina</h1>
+        <p>A production-grade Express.js starter kit crafted with TypeScript. Features a fully Object-Oriented architecture, Singleton services, and type-safe database interactions.</p>
+        
+        <div class="status">Application is Running</div>
+
+        <div class="links">
+            <a href="/status">System Status</a>
+            <a href="https://github.com/glensonansin/lumina" target="_blank">Documentation</a>
+        </div>
+    </div>
+</body>
+</html>