crypt-express-app 1.0.0 → 1.3.0

package/README.md

@@ -1 +1,321 @@
-# crypt-express-app
+# crypt-express-app
+
+🚀 A production-ready Express + TypeScript backend starter CLI with Prisma, Redis, i18n, Swagger, Docker, and scalable modular architecture.
+
+---
+
+## ✨ What is crypt-express-app?
+
+`crypt-express-app` is a CLI tool that instantly scaffolds a fully structured, enterprise-grade Express backend application.
+
+It generates:
+
+- Express + TypeScript setup
+- Prisma ORM configuration
+- PostgreSQL + Redis Docker setup
+- Swagger documentation
+- i18next internationalization
+- Modular folder architecture
+- Logger + Error handling middleware
+- Environment configuration
+- Ready-to-run Docker Compose stack
+
+This tool is built for developers who want a clean, scalable backend architecture in seconds.
+
+---
+
+# 📦 Installation
+
+You don’t install it globally.
+
+Use directly with npx:
+
+```bash
+npx crypt-express-app my-project
+```
+
+Or inside current directory:
+
+```bash
+npx crypt-express-app .
+```
+
+---
+
+# 🧠 What It Generates
+
+After running the CLI, your project will include:
+
+```
+my-project/
+│
+├── src/
+│   ├── app.ts
+│   ├── routes.ts
+│   ├── prisma/
+│   │   └── client.ts
+│   ├── utils/
+│   ├── middlewares/
+│   ├── locales/
+│   └── modules/
+│
+├── prisma/
+│   └── schema.prisma
+├── server.ts
+├── .env
+├── .env.dev
+├── .env.prod
+├── example.env
+├── Dockerfile
+├── docker-compose.yml
+├── tsconfig.json
+└── package.json
+```
+
+---
+
+# 🔥 Features
+
+## ✅ Express + TypeScript
+- Clean app architecture
+- Modular routing system
+- Centralized error handling
+- Logger middleware
+
+## ✅ Prisma ORM
+- PostgreSQL configuration
+- Auto Prisma client setup
+- prisma.config.ts support
+
+## ✅ Redis Cache
+- Redis service container
+- Cache service wrapper
+- TTL-based caching support
+
+## ✅ Internationalization (i18n)
+- English + Bengali support
+- Language detection
+- JSON-based translations
+
+## ✅ Swagger API Docs
+- OpenAPI 3.0 setup
+- Bearer auth support
+- Persist authorization enabled
+
+Access at:
+
+```
+http://localhost:3000/api/docs
+```
+
+## ✅ Docker Ready
+- Node service container
+- PostgreSQL container
+- Redis container
+- Volume persistence
+- Production-ready configuration
+
+---
+
+# 🚀 Quick Start
+
+After project generation:
+
+```bash
+cd my-project
+```
+
+Start infrastructure:
+
+```bash
+docker compose up -d postgres redis
+```
+
+Generate Prisma client:
+
+```bash
+npx prisma generate
+```
+
+Run development server:
+
+```bash
+pnpm dev
+```
+
+Or build and run:
+
+```bash
+pnpm build
+pnpm start
+```
+
+---
+
+# 🌍 Environment Variables
+
+Default `.env`:
+
+```
+PORT=3000
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/app_db
+REDIS_URL=redis://localhost:6379
+```
+
+For Docker (`.env.dev`):
+
+```
+DATABASE_URL=postgresql://postgres:postgres@postgres:5432/app_db
+REDIS_URL=redis://redis:6379
+```
+
+---
+
+# 🐳 Docker Usage
+
+Start everything:
+
+```bash
+docker compose up --build
+```
+
+Only database + redis:
+
+```bash
+docker compose up -d postgres redis
+```
+
+Stop:
+
+```bash
+docker compose down
+```
+
+---
+
+# 🧩 Architecture Philosophy
+
+crypt-express-app follows a clean separation:
+
+- `app.ts` → Express configuration
+- `routes.ts` → Route registration
+- `modules/` → Feature modules
+- `utils/` → Shared services
+- `middlewares/` → Cross-cutting concerns
+- `prisma/` → Database client layer
+
+This makes scaling large backend systems easier.
+
+---
+
+# 📌 CLI Behavior
+
+If project name contains spaces:
+
+```
+"My App Project"
+```
+
+It auto converts to:
+
+```
+my-app-project
+```
+
+---
+
+# 🛠 Scripts
+
+Generated project includes:
+
+```json
+"dev": "nodemon",
+"build": "tsc && npm run copy-locales",
+"start": "node dist/server.js"
+```
+
+---
+
+# 📚 Requirements
+
+- Node.js 18+
+- pnpm or npm
+- Docker (optional but recommended)
+- PostgreSQL
+- Redis
+
+---
+
+# 🔐 Production Ready
+
+This starter includes:
+
+- Structured logging
+- Error middleware
+- Swagger security
+- Environment separation
+- Docker orchestration
+- Prisma adapter configuration
+
+You can safely use this as a base for:
+
+- SaaS backend
+- Microservices
+- Enterprise REST APIs
+- Auth servers
+- Admin panels
+
+---
+
+# 🤝 Contributing
+
+Pull requests are welcome.
+
+1. Fork repository
+2. Create feature branch
+3. Submit PR
+
+---
+
+# 📄 License
+
+ISC
+
+---
+
+# 👨‍💻 Author
+
+Abir Hosen
+
+---
+
+# ⭐ Why crypt-express-app?
+
+Because setting up backend boilerplate repeatedly is painful.
+
+crypt-express-app removes:
+
+- Folder setup time
+- Docker setup time
+- Prisma configuration time
+- Redis setup time
+- Swagger configuration time
+- i18n wiring time
+
+Start coding business logic immediately.
+
+---
+
+# 🚀 Future Roadmap
+
+- Auth module generator
+- Role-based access control
+- GraphQL support
+- Microservice mode
+- CLI flags support
+- Health check system
+- CI/CD template
+
+---
+
+Enjoy building scalable backends 🚀

package/{scripts/generate-module.ts → dist/generate-module.js}

@@ -1,75 +1,43 @@
 // generate-module.ts
 import * as fs from 'fs';
 import * as path from 'path';
-
 // get module name from command line
 const args = process.argv.slice(2);
-
 // Check that exactly **one argument** is provided
 if (args.length !== 1) {
-  console.error('Invalid module name: provide exactly one module name without spaces.');
-  console.error('Example: npm run generate-module clientRole');
-  process.exit(1);
+    console.error('Invalid module name: provide exactly one module name without spaces.');
+    console.error('Example: npm run generate-module clientRole');
+    process.exit(1);
 }
-
 const moduleInput = args[0];
-
 // Reject if input contains spaces
 if (/\s/.test(moduleInput)) {
-  console.error('Invalid module name: spaces are not allowed. Use camelCase, kebab-case or snake_case.');
-  process.exit(1);
+    console.error('Invalid module name: spaces are not allowed. Use camelCase, kebab-case or snake_case.');
+    process.exit(1);
 }
-
 if (!moduleInput) {
-  console.error('Please provide a module name: npm run generate-module <module-name>');
-  process.exit(1);
+    console.error('Please provide a module name: npm run generate-module <module-name>');
+    process.exit(1);
 }
-
 // Convert any input to camelCase
 const moduleName = moduleInput.includes('-') || moduleInput.includes('_') || moduleInput.includes(' ')
-  ? moduleInput
-      .toLowerCase()
-      .replace(/[-_\s]+(.)/g, (_, c) => c.toUpperCase())
-  : moduleInput; // preserve existing camelCase
-
-console.log("moduleName: ", moduleName)
-
+    ? moduleInput
+        .toLowerCase()
+        .replace(/[-_\s]+(.)/g, (_, c) => c.toUpperCase())
+    : moduleInput; // preserve existing camelCase
+console.log("moduleName: ", moduleName);
 // Convert any input (camelCase, PascalCase, snake_case, spaces) to kebab-case
 const fileName = moduleName
-  .replace(/([a-z])([A-Z])/g, '$1-$2') // add dash before uppercase letters
-  .toLowerCase();                       // lowercase everything
-
-console.log("fileName: ", fileName)
-
-
-// const basePath = path.join(__dirname, '..', 'src', 'modules', fileName);
-// const basePath = path.join(__dirname, '..', 'src', 'modules', fileName);
-const projectRoot = process.cwd();
-const modulesRoot = path.join(projectRoot, "src", "modules");
-const basePath = path.join(modulesRoot, fileName);
-
-// ensure modules directory exists
-if (!fs.existsSync(modulesRoot)) {
-  fs.mkdirSync(modulesRoot, { recursive: true });
-}
-
-// prevent overwrite
-if (fs.existsSync(basePath)) {
-  console.error(`❌ Module '${fileName}' already exists.`);
-  process.exit(1);
-}
-
-fs.mkdirSync(basePath, { recursive: true });
-
-
+    .replace(/([a-z])([A-Z])/g, '$1-$2') // add dash before uppercase letters
+    .toLowerCase(); // lowercase everything
+console.log("fileName: ", fileName);
+const basePath = path.join(__dirname, '..', 'src', 'modules', fileName);
 // Create folder
 if (!fs.existsSync(basePath)) {
-  fs.mkdirSync(basePath, { recursive: true });
+    fs.mkdirSync(basePath, { recursive: true });
 }
-
 // Capitalize first letter
 const ModuleClassName = moduleName.charAt(0).toUpperCase() + moduleName.slice(1);
-
 // Service
 const serviceContent = `import { Create${ModuleClassName}Dto, Update${ModuleClassName}Dto, Create${ModuleClassName}Response, Update${ModuleClassName}Response, Get${ModuleClassName}Response, List${ModuleClassName}Response } from "./${fileName}.dto";
 import { Prisma } from "@prisma/client";
@@ -158,9 +126,7 @@ export class ${ModuleClassName}Service {
 
 export default new ${ModuleClassName}Service()
 `;
-
 fs.writeFileSync(path.join(basePath, `${fileName}.service.ts`), serviceContent);
-
 // Controller
 const controllerContent = `
 import { Request, Response } from 'express';
@@ -277,9 +243,7 @@ export class ${ModuleClassName}Controller {
   }
 }
 `;
-
 fs.writeFileSync(path.join(basePath, `${fileName}.controller.ts`), controllerContent);
-
 // Routes
 const routesContent = `
 import express, { Router } from 'express';
@@ -287,13 +251,13 @@ import { ${ModuleClassName}Controller } from './${fileName}.controller';
 import { ${moduleName}Middleware } from './${fileName}.middlewares';
 import { authMiddleware } from '../../middlewares/auth.middleware';
 import ${moduleName}Service from './${fileName}.service';
-import { ActionsType, Resource, ResourceType } from '../../utils/consts';
+import { TypeAction, Resource, TypeResource } from '../../utils/consts';
 import { authorizationMiddleware } from '../../middlewares/authorization.middleware';
 
 const router: Router = express.Router();
 const controller = new ${ModuleClassName}Controller(${moduleName}Service);
 router.use(authMiddleware);
-const guard = (actions: ActionsType[]) => authorizationMiddleware({ resource: Resource.COMMON, actions, resourceType: ResourceType.API_ENDPOINT });
+const guard = (actions: TypeAction[]) => authorizationMiddleware({ resource: Resource.COMMON, actions, resourceType: TypeResource.API_ENDPOINT });
 
 /**
  * @openapi
@@ -322,7 +286,7 @@ const guard = (actions: ActionsType[]) => authorizationMiddleware({ resource: Re
  *             schema:
  *               $ref: '#/components/schemas/Create${ModuleClassName}ResponseDto'
  */
-router.post('/', ${moduleName}Middleware, guard([ActionsType.CREATE]), controller.create.bind(controller));
+router.post('/', ${moduleName}Middleware, guard([TypeAction.CREATE]), controller.create.bind(controller));
 
 /**
  * @openapi
@@ -344,7 +308,7 @@ router.post('/', ${moduleName}Middleware, guard([ActionsType.CREATE]), controlle
  *             schema:
  *               $ref: '#/components/schemas/Get${ModuleClassName}ResponseDto'
  */
-router.get('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.READ]), controller.getById.bind(controller));
+router.get('/:${moduleName}Id', ${moduleName}Middleware, guard([TypeAction.READ]), controller.getById.bind(controller));
 
 /**
  * @openapi
@@ -372,7 +336,7 @@ router.get('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.READ
  *             schema:
  *               $ref: '#/components/schemas/Update${ModuleClassName}ResponseDto'
  */
-router.put('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.UPDATE]), controller.update.bind(controller));
+router.put('/:${moduleName}Id', ${moduleName}Middleware, guard([TypeAction.UPDATE]), controller.update.bind(controller));
 
 /**
  * @openapi
@@ -401,7 +365,7 @@ router.put('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.UPDA
  *                 message:
  *                   type: string
  */
-router.delete('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.DELETE]), controller.delete.bind(controller));
+router.delete('/:${moduleName}Id', ${moduleName}Middleware, guard([TypeAction.DELETE]), controller.delete.bind(controller));
 
 /**
  * @openapi
@@ -444,7 +408,7 @@ router.delete('/:${moduleName}Id', ${moduleName}Middleware, guard([ActionsType.D
  *             schema:
  *               $ref: '#/components/schemas/List${ModuleClassName}ResponseDto'
  */
-router.get('/', ${moduleName}Middleware, guard([ActionsType.READ_ALL]), controller.list.bind(controller));
+router.get('/', ${moduleName}Middleware, guard([TypeAction.READ_ALL]), controller.list.bind(controller));
 
 /**
  * ======================================================
@@ -461,8 +425,6 @@ router.get('/health/check', (_req, res) => {
 
 export default router;
 `;
-
-
 fs.writeFileSync(path.join(basePath, `${fileName}.routes.ts`), routesContent);
 const dtoContent = `import { ApiResponse, PaginatedData } from "../common/common.dto";
 
@@ -639,10 +601,7 @@ export interface Get${ModuleClassName}ResponseDto
 export interface List${ModuleClassName}ResponseDto
   extends ApiResponse<PaginatedData<Partial<${ModuleClassName}>>> {}
 `;
-
-
 fs.writeFileSync(path.join(basePath, `${fileName}.dto.ts`), dtoContent);
-
 // Middleware
 const middlewareContent = `
 import { Request, Response, NextFunction } from "express";
@@ -695,21 +654,5 @@ export async function ${moduleName}Middleware(req: Request, res: Response, next:
   }
 }
 `;
-
 fs.writeFileSync(path.join(basePath, `${fileName}.middlewares.ts`), middlewareContent);
-
-const routerIndexPath = path.join(projectRoot, "src", "routes.ts");
-
-if (fs.existsSync(routerIndexPath)) {
-  fs.appendFileSync(
-    routerIndexPath,
-    `\nimport ${moduleName}Routes from "./modules/${fileName}/${fileName}.routes";`
-  );
-
-  fs.appendFileSync(
-    routerIndexPath,
-    `\nrouter.use("/${moduleName}", ${moduleName}Routes);\n`
-  );
-}
-
 console.log(`Module '${moduleName}' generated successfully at ${basePath}`);

package/dist/index.js

@@ -1,20 +1,125 @@
 #!/usr/bin/env node
 import { execSync } from "child_process";
-const projectName = process.argv[2];
-if (!projectName) {
-    console.error("❌ project-name required");
-    console.log("Usage: npx crypt-express-app <project-name>");
-    process.exit(1);
+import * as fs from "fs";
+import * as path from "path";
+import * as readline from "readline";
+import { generateApp } from "./scripts/generate-app.js";
+import { generateLocales } from "./scripts/generate-locales.js";
+import { generateMiddlewares } from "./scripts/generate-middleware.js";
+import { generateRootFiles } from "./scripts/generate-root-files.js";
+import { generateModule } from "./scripts/generate-module.js";
+import { generateUtils } from "./scripts/generate-utils.js";
+import { generatePrismaClient } from "./scripts/setup-prisma.js";
+/* ===================== CLI SETUP ===================== */
+const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+});
+function ask(question) {
+    return new Promise((resolve) => rl.question(question, resolve));
 }
-process.env.PROJECT_NAME = projectName;
-function run(cmd) {
-    execSync(cmd, { stdio: "inherit" });
-}
-// run generators
-// run("tsx scripts/generate-root-files.ts");
-// run("tsx scripts/generate-utils.ts");
-// run("tsx scripts/generate-locales.ts");
-// run("tsx scripts/setup-prisma.ts");
-// run("tsx scripts/generate-middleware.ts");
-// run("tsx scripts/generate-module.ts common");
-console.log("✅ project generated");
+/* ===================== MAIN ===================== */
+(async function main() {
+    let projectName = process.argv[2];
+    if (process.argv.length > 3) {
+        console.error("❌ only one project name allowed");
+        process.exit(1);
+    }
+    if (!projectName) {
+        projectName = await ask("Enter project name: ");
+    }
+    projectName = projectName.trim();
+    if (!projectName) {
+        console.error("❌ Project name required");
+        process.exit(1);
+    }
+    // allow spaces → convert to kebab-case
+    const normalizedName = projectName
+        .toLowerCase()
+        .trim()
+        .replace(/\s+/g, "-") // space → dash
+        .replace(/[^a-z0-9-]/g, ""); // remove invalid chars (optional)
+    const useCurrentDir = projectName === ".";
+    const projectDir = useCurrentDir
+        ? process.cwd()
+        : path.join(process.cwd(), projectName);
+    if (!useCurrentDir) {
+        if (/\s/.test(projectName)) {
+            console.error("❌ Name cannot contain spaces");
+            process.exit(1);
+        }
+        if (fs.existsSync(projectDir)) {
+            console.error("❌ Directory already exists");
+            process.exit(1);
+        }
+        fs.mkdirSync(projectDir, { recursive: true });
+    }
+    else {
+        const files = fs.readdirSync(projectDir).filter((f) => !f.startsWith("."));
+        if (files.length > 0) {
+            console.error("❌ Current directory must be empty");
+            process.exit(1);
+        }
+    }
+    rl.close();
+    const finalProjectName = useCurrentDir ? path.basename(process.cwd())
+        .toLowerCase()
+        .trim()
+        .replace(/\s+/g, "-") // space → dash
+        .replace(/[^a-z0-9-]/g, "") // remove invalid chars (optional)
+        : normalizedName;
+    process.env.PROJECT_NAME = finalProjectName;
+    console.log(`📦 Creating project: ${process.env.PROJECT_NAME}`);
+    generateRootFiles(projectDir, finalProjectName);
+    generateApp(projectDir);
+    generateMiddlewares(projectDir);
+    generateLocales(projectDir);
+    generateModule(projectDir, "common");
+    generateUtils(projectDir);
+    generatePrismaClient(projectDir);
+    console.log("📦 Installing dependencies...");
+    try {
+        execSync("pnpm install", {
+            cwd: projectDir,
+            stdio: "inherit",
+        });
+        console.log("✅ Dependencies installed");
+    }
+    catch (err) {
+        console.error("❌ pnpm install failed");
+        console.error(err);
+    }
+    try {
+        execSync("npx prisma generate", {
+            cwd: projectDir,
+            stdio: "inherit",
+        });
+        console.log("✅ Prisma client generated");
+    }
+    catch (err) {
+        console.error("❌ Prisma client generation failed");
+        console.error(err);
+    }
+    // try {
+    //   execSync("docker compose up -d redis postgres", {
+    //     cwd: projectDir,
+    //     stdio: "inherit",
+    //   });
+    //   console.log("✅ Redis and Postgres started");
+    // } catch (err) {
+    //   console.error("❌ Failed to start Redis and Postgres");
+    //   console.error(err);
+    // }
+    // try {
+    //   execSync("npx prisma db push", {
+    //     cwd: projectDir,
+    //     stdio: "inherit",
+    //   });
+    //   console.log("✅ Prisma client generated");
+    // } catch (err) {
+    //   console.error("❌ Prisma client generation failed");
+    //   console.error(err);
+    // }
+    console.log("✅ Project generated");
+})();
+/* ===================== CONFIG GENERATION ===================== */