@imksh/create 1.0.27 → 1.0.28

package/templates/node/README.md

@@ -1,67 +0,0 @@
-# Node.js Backend Boilerplate
-
-A production-ready, feature-rich Node.js & Express boilerplate project with best-practice architectures, modular routing, and robust configuration.
-
-## Features
-
-- ⚙️ **Modular Architecture:** Express application setup decoupled into `app.js` (middleware + router wiring) and `index.js` (server initialization & db connection).
-- 📝 **Colorized Logging:** Zero-dependency custom logger with timestamped success, warning, info, and error layouts.
-- 🛡️ **Security Out-of-the-Box:** Pre-configured with Helmet headers, CORS policies, and global rate limiters (`apiLimiter`, `authLimiter`, `uploadLimiter`).
-- 🔑 **Authentication & JWT:** Custom middlewares for route protection, sign-ups, and log-ins with HTTP-only cookie-based tokens.
-- 📧 **SMTP Mailer & OTP:** Standard mailer transport using Gmail NodeMailer wrapper, integrated with an OTP generator and email template.
-- 🖼️ **File Uploads:** Cloudinary integration utilizing Multer memory buffers for secure, single or multi-file uploads.
-- 🔌 **Socket.io Setup:** Pre-installed Socket.io hooks mapping connected user sessions to active sockets.
-- ✉️ **Web Push:** Push notifications integration powered by VAPID key generators and web-push subscriptions.
-
-## Getting Started
-
-### 1. Configure Environment Variables
-
-Create a `.env` file in the root directory (based on `.env.example`):
-
-```env
-PORT=5001
-JWT_SECRET=your_super_secret_jwt_key
-MONGO_URI=your_mongodb_connection_uri
-
-# Cloudinary
-CLOUDINARY_CLOUD_NAME=your_cloud_name
-CLOUDINARY_API_KEY=your_api_key
-CLOUDINARY_API_SECRET=your_api_secret
-
-# SMTP Settings
-SMTP_USER=your_email@gmail.com
-SMTP_PASS=your_app_password
-
-# Web Push
-VAPID_SUBJECT=mailto:your_email@example.com
-VAPID_PUBLIC_KEY=your_vapid_public_key
-VAPID_PRIVATE_KEY=your_vapid_private_key
-```
-
-### 2. Install & Start Development
-
-```bash
-# Install dependencies
-npm install
-
-# Start development server with reload
-npm run dev
-
-# Start production server
-npm start
-```
-
-## API Endpoints
-
-### Auth Routes (`/api/auth`)
-
-- `POST /signup` - Registers a new user session
-- `POST /login` - Log in user and write token cookie
-- `POST /logout` - Clear token session cookies
-- `GET /me` - Returns logged-in user profile (requires auth)
-- `PUT /me` - Edit profile info and upload avatars (requires auth)
-
-### Upload Routes (`/api/upload`)
-
-- `POST /` - Securely uploads image/file to Cloudinary (requires auth)

package/templates/node/_gitignore

@@ -1,24 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
-
-node_modules
-dist
-dist-ssr
-*.local
-
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?

package/templates/node/src/app.js

@@ -1,42 +0,0 @@
-import express from "express";
-import helmet from "helmet";
-import cors from "cors";
-import compression from "compression";
-import cookieParser from "cookie-parser";
-import morgan from "morgan";
-import apiRoutes from "./routes/index.js";
-import { notFound, errorHandler } from "./middleware/errorHandler.js";
-import { apiLimiter } from "./middleware/rateLimiter.js";
-
-const app = express();
-
-// Security and utility middlewares
-app.use(helmet());
-app.use(
-  cors({
-    origin: process.env.CLIENT_URL || "http://localhost:5173",
-    credentials: true,
-  })
-);
-app.use(compression());
-app.use(express.json());
-app.use(express.urlencoded({ extended: true }));
-app.use(cookieParser());
-app.use(morgan("dev"));
-
-// Rate limiting
-app.use(apiLimiter);
-
-// API Routes
-app.use("/api", apiRoutes);
-
-// Example health route
-app.get("/api/health", (req, res) => {
-  res.status(200).json({ success: true, message: "API is running" });
-});
-
-// Error handling middlewares
-app.use(notFound);
-app.use(errorHandler);
-
-export default app;

package/templates/node/src/config/cloudinary.js

@@ -1,9 +0,0 @@
-import { v2 as cloudinary } from "cloudinary";
-
-cloudinary.config({
-  cloud_name: process.env.CLOUDINARY_CLOUD_NAME,
-  api_key: process.env.CLOUDINARY_API_KEY,
-  api_secret: process.env.CLOUDINARY_API_SECRET,
-});
-
-export default cloudinary;

package/templates/node/src/config/db.js

@@ -1,14 +0,0 @@
-import mongoose from "mongoose";
-import logger from "../utils/logger.js";
-
-const connectDB = async () => {
-  try {
-    const conn = await mongoose.connect(process.env.MONGO_URI);
-    logger.success(`MongoDB connected: ${conn.connection.host}`);
-  } catch (error) {
-    logger.error(`MongoDB connection error: ${error.message}`, error);
-    process.exit(1);
-  }
-};
-
-export default connectDB;

package/templates/node/src/config/dotenv.js

@@ -1,2 +0,0 @@
-import dotenv from "dotenv";
-dotenv.config();

package/templates/node/src/config/email.js

@@ -1,30 +0,0 @@
-// import dotenv from "dotenv";
-// dotenv.config();
-import nodemailer from "nodemailer";
-import logger from "../utils/logger.js";
-
-const sendEmail = async (to, subject, message) => {
-  try {
-    const transporter = nodemailer.createTransport({
-      service: "gmail",
-      auth: {
-        user: process.env.SMTP_USER,
-        pass: process.env.SMTP_PASS,
-      },
-    });
-
-    const mailOptions = {
-      from: process.env.SMTP_USER,
-      to: to,
-      subject: subject,
-      html: message,
-    };
-
-    const res = await transporter.sendMail(mailOptions);
-    logger.success(`Email sent to ${to}: ${res.messageId}`);
-  } catch (error) {
-    logger.error("Failed to send email", error);
-  }
-};
-
-export default sendEmail;

package/templates/node/src/config/socket.js

@@ -1,54 +0,0 @@
-import { Server } from "socket.io";
-import logger from "../utils/logger.js";
-
-let io;
-
-const userSocketMap = {};
-
-const initializeSocket = (server) => {
-  io = new Server(server, {
-    cors: {
-      origin: ["http://localhost:5173"],
-      credentials: true,
-    },
-  });
-
-  io.on("connection", (socket) => {
-    const userId = socket.handshake.auth.userId;
-
-    if (!userId) {
-      logger.warn("No userId, disconnecting socket");
-      socket.disconnect();
-      return;
-    }
-
-    logger.info(`Socket connected: ${socket.id} (User: ${userId})`);
-
-    if (!userSocketMap[userId]) {
-      userSocketMap[userId] = new Set();
-    }
-    userSocketMap[userId].add(socket.id);
-
-    socket.on("disconnect", (reason) => {
-      if (!userId) return;
-      userSocketMap[userId].delete(socket.id);
-      logger.info(`Socket disconnected: ${socket.id} (Reason: ${reason})`);
-    });
-  });
-
-  return io;
-};
-
-export const getIO = () => {
-  if (!io) {
-    throw new Error("Socket.IO has not been initialized yet");
-  }
-  return io;
-};
-
-const getReceiverSocketIds = (userId) =>
-  userSocketMap[userId] ? Array.from(userSocketMap[userId]) : [];
-
-export { io, getReceiverSocketIds, userSocketMap };
-
-export default initializeSocket;

package/templates/node/src/config/webPush.js

@@ -1,9 +0,0 @@
-import webpush from "web-push";
-
-webpush.setVapidDetails(
-  process.env.VAPID_SUBJECT, 
-  process.env.VAPID_PUBLIC_KEY,
-  process.env.VAPID_PRIVATE_KEY
-);
-
-export default webpush;

package/templates/node/src/controllers/upload.controller.js

@@ -1,26 +0,0 @@
-import { uploadSingleToCloudinary } from "../utils/cloudinaryUpload.js";
-import logger from "../utils/logger.js";
-
-/**
- * Handle single file uploads to Cloudinary
- */
-export const uploadFile = async (req, res, next) => {
-  try {
-    if (!req.file) {
-      return res.status(400).json({ success: false, message: "No file uploaded" });
-    }
-
-    const result = await uploadSingleToCloudinary(req.file, {
-      folder: req.body.folder || "general_uploads",
-    });
-
-    res.status(200).json({
-      success: true,
-      message: "File uploaded successfully",
-      data: result,
-    });
-  } catch (error) {
-    logger.error("Upload controller error", error);
-    next(error);
-  }
-};

package/templates/node/src/index.js

@@ -1,24 +0,0 @@
-import dotenv from "dotenv";
-import http from "http";
-import app from "./app.js";
-import connectDB from "./config/db.js";
-import logger from "./utils/logger.js";
-// import initializeSocket from "./config/socket.js";
-
-dotenv.config();
-
-const PORT = process.env.PORT || 5000;
-
-// Connect to Database
-connectDB();
-
-// Create HTTP Server
-const server = http.createServer(app);
-
-// Wire Socket.io (Commented out by default)
-// initializeSocket(server);
-
-// Start Server
-server.listen(PORT, () => {
-  logger.success(`Server is running on port ${PORT}`);
-});

package/templates/node/src/middleware/auth.middleware.js

@@ -1,43 +0,0 @@
-import jwt from "jsonwebtoken";
-import User from "../models/user.model.js";
-import { verifyToken } from "../utils/jwt.js";
-import logger from "../utils/logger.js";
-
-export const protect = async (req, res, next) => {
-  let token;
-  if (req.cookies?.token) {
-    token = req.cookies.token;
-  } else if (
-    req.headers.authorization &&
-    req.headers.authorization.startsWith("Bearer")
-  ) {
-    token = req.headers.authorization.split(" ")[1];
-  }
-
-  if (!token) {
-    return res
-      .status(401)
-      .json({ message: "Not authorized, no token provided" });
-  }
-
-  try {
-    const decoded = verifyToken(token);
-    if (!decoded) {
-      return res.status(401).json({ message: "Not authorized, invalid token" });
-    }
-
-    req.user = await User.findById(decoded.id).select("-password");
-    if (!req.user) {
-      return res
-        .status(401)
-        .json({ message: "Not authorized, user not found" });
-    }
-
-    return next();
-  } catch (error) {
-    logger.error("Auth middleware error", error);
-    return res
-      .status(401)
-      .json({ message: "Not authorized, token verification failed" });
-  }
-};

package/templates/node/src/middleware/errorHandler.js

@@ -1,22 +0,0 @@
-/**
- * Not Found Middleware
- * Catches all unmatched requests and forwards a 404 error
- */
-export const notFound = (req, res, next) => {
-  const error = new Error(`Not Found - ${req.originalUrl}`);
-  res.status(404);
-  next(error);
-};
-
-/**
- * Global Error Handler Middleware
- * Formats error responses nicely in JSON
- */
-export const errorHandler = (err, req, res, next) => {
-  const statusCode = err.status || err.statusCode || (res.statusCode === 200 ? 500 : res.statusCode);
-  res.status(statusCode).json({
-    success: false,
-    message: err.message || "An unexpected error occurred",
-    stack: process.env.NODE_ENV === "production" ? undefined : err.stack,
-  });
-};

package/templates/node/src/middleware/multer.js

@@ -1,21 +0,0 @@
-import multer from "multer";
-
-// Configure memory storage to receive file buffers directly
-const storage = multer.memoryStorage();
-
-// Validate file types (only allow common image formats)
-const fileFilter = (req, file, cb) => {
-  if (file.mimetype.startsWith("image/")) {
-    cb(null, true);
-  } else {
-    cb(new Error("Only image files are allowed!"), false);
-  }
-};
-
-export const upload = multer({
-  storage,
-  fileFilter,
-  limits: {
-    fileSize: 5 * 1024 * 1024, // 5MB limit
-  },
-});

package/templates/node/src/middleware/rateLimiter.js

@@ -1,57 +0,0 @@
-import rateLimit from "express-rate-limit";
-
-const createLimiter = ({
-  windowMs,
-  max,
-  message,
-  skipSuccessfulRequests = false,
-}) =>
-  rateLimit({
-    windowMs,
-    max,
-    standardHeaders: true,
-    legacyHeaders: false,
-    skipSuccessfulRequests,
-
-    keyGenerator: (req) => {
-      return req.user?.id || req.ip || req.headers["x-forwarded-for"] || req.socket.remoteAddress;
-    },
-
-    handler: (req, res) => {
-      res.status(429).json({
-        success: false,
-        message,
-      });
-    },
-  });
-
-/**
- * General API Limiter
- * 100 requests / 15 minutes
- */
-export const apiLimiter = createLimiter({
-  windowMs: 15 * 60 * 1000,
-  max: 100,
-  message: "Too many requests. Please try again later.",
-});
-
-/**
- * Authentication Limiter
- * 10 failed attempts / 15 minutes
- */
-export const authLimiter = createLimiter({
-  windowMs: 15 * 60 * 1000,
-  max: 10,
-  skipSuccessfulRequests: true,
-  message: "Too many login attempts. Please try again later.",
-});
-
-/**
- * Upload Limiter
- * 20 uploads / hour
- */
-export const uploadLimiter = createLimiter({
-  windowMs: 60 * 60 * 1000,
-  max: 20,
-  message: "Upload limit reached. Please try again in an hour.",
-});

package/templates/node/src/models/otp.model.js

@@ -1,21 +0,0 @@
-import mongoose from "mongoose";
-
-const otpSchema = new mongoose.Schema({
-  email: {
-    type: String,
-    required: true,
-  },
-  otp: {
-    type: String,
-    required: true,
-  },
-  createdAt: {
-    type: Date,
-    default: Date.now(),
-    expires: 300,
-  },
-});
-
-const Otp = mongoose.model("Otp", otpSchema);
-
-export default Otp;

package/templates/node/src/routes/auth.route.js

@@ -1,22 +0,0 @@
-import express from "express";
-import {
-  signup,
-  login,
-  getMe,
-  logout,
-  updateMe,
-} from "../controllers/auth.controller.js";
-import { protect } from "../middleware/auth.middleware.js";
-import { apiLimiter } from "../middleware/rateLimiter.js";
-
-const router = express.Router();
-
-router.use(apiLimiter);
-
-router.post("/signup", signup);
-router.post("/login", login);
-router.post("/logout", logout);
-router.get("/me", protect, getMe);
-router.put("/me", protect, updateMe);
-
-export default router;

package/templates/node/src/routes/index.js

@@ -1,12 +0,0 @@
-import express from "express";
-import authRoutes from "./auth.route.js";
-import uploadRoutes from "./upload.route.js";
-import pushRoutes from "./push.route.js";
-
-const router = express.Router();
-
-router.use("/auth", authRoutes);
-router.use("/upload", uploadRoutes);
-router.use("/push", pushRoutes);
-
-export default router;

package/templates/node/src/routes/upload.route.js

@@ -1,12 +0,0 @@
-import express from "express";
-import { upload } from "../middleware/multer.js";
-import { uploadFile } from "../controllers/upload.controller.js";
-import { protect } from "../middleware/auth.middleware.js";
-import { uploadLimiter } from "../middleware/rateLimiter.js";
-
-const router = express.Router();
-
-// Mount file upload route (protected by auth and rate-limited)
-router.post("/", protect, uploadLimiter, upload.single("file"), uploadFile);
-
-export default router;

package/templates/node/src/utils/authToken.js

@@ -1,26 +0,0 @@
-import jwt from "jsonwebtoken";
-
-export const genToken = async (user, res) => {
-  try {
-    const payload = {
-      id: user._id,
-      role: user.role || "admin",
-    };
-    const token = await jwt.sign(payload, process.env.JWT_SECRET, {
-      expiresIn: "1d",
-    });
-    //expires in day=1d,in hour=1h,in seconds=1
-
-    console.log(token);
-    res.cookie("token", token, {
-      maxAge: 1000 * 60 * 60 * 24,
-      httpOnly: process.env.NODE_ENV !== "production" ? false : true,
-      secure: process.env.NODE_ENV !== "production" ? false : true,
-      sameSite: process.env.NODE_ENV !== "production" ? "lax" : "none",
-    });
-    return token;
-  } catch (error) {
-    console.log(error);
-    throw error;
-  }
-};

package/templates/node/src/utils/cloudinary.js

@@ -1,27 +0,0 @@
-import { v2 as cloudinary } from "cloudinary";
-import { CloudinaryStorage } from "multer-storage-cloudinary";
-import multer from "multer";
-
-cloudinary.config({
-  cloud_name: process.env.CLOUDINARY_CLOUD_NAME,
-  api_key: process.env.CLOUDINARY_API_KEY,
-  api_secret: process.env.CLOUDINARY_API_SECRET,
-});
-
-// Storage engine for profile images / file submissions
-const storage = new CloudinaryStorage({
-  cloudinary,
-  params: (req, file) => ({
-    folder: "lms-uploads",
-    allowed_formats: ["jpg", "jpeg", "png", "gif", "pdf", "webp"],
-    resource_type: file.mimetype.startsWith("image/") ? "image" : "raw",
-    public_id: `${Date.now()}-${file.originalname.replace(/\s+/g, "_")}`,
-  }),
-});
-
-export const upload = multer({
-  storage,
-  limits: { fileSize: 10 * 1024 * 1024 }, // 10 MB cap
-});
-
-export { cloudinary };

package/templates/node/src/utils/cloudinaryUpload.js

@@ -1,87 +0,0 @@
-import cloudinary from "../config/cloudinary.js";
-import logger from "./logger.js";
-
-const uploadToCloudinary = async (
-  file,
-  {
-    folder = "uploads",
-    width,
-    height,
-    crop,
-    quality = "auto",
-    format = "auto",
-    ...options
-  } = {},
-) => {
-  if (!file?.buffer) {
-    throw new Error("Invalid file.");
-  }
-
-  const dataURI = `data:${file.mimetype};base64,${file.buffer.toString(
-    "base64",
-  )}`;
-
-  const result = await cloudinary.uploader.upload(dataURI, {
-    folder,
-    width,
-    height,
-    crop,
-    quality,
-    format,
-    ...options,
-  });
-
-  return {
-    url: result.secure_url,
-    publicId: result.public_id,
-    assetId: result.asset_id,
-    width: result.width,
-    height: result.height,
-    format: result.format,
-    bytes: result.bytes,
-  };
-};
-
-/**
- * Upload Single Image
- */
-export const uploadSingleToCloudinary = async (
-  file,
-  options = {},
-) => {
-  try {
-    return await uploadToCloudinary(file, options);
-  } catch (error) {
-    logger.error("Cloudinary Upload Error", error);
-    throw new Error("Failed to upload image.");
-  }
-};
-
-/**
- * Upload Multiple Images
- */
-export const uploadMultipleToCloudinary = async (
-  files = [],
-  options = {},
-) => {
-  try {
-    return await Promise.all(
-      files.map((file) => uploadToCloudinary(file, options)),
-    );
-  } catch (error) {
-    logger.error("Cloudinary Upload Error", error);
-    throw new Error("Failed to upload images.");
-  }
-};
-
-/**
- * Delete Image
- */
-export const deleteFromCloudinary = async (publicId) => {
-  try {
-    return await cloudinary.uploader.destroy(publicId);
-  } catch (error) {
-    logger.error("Cloudinary Delete Error", error);
-    throw new Error("Failed to delete image.");
-  }
-};