crypt-express-app 1.3.20

package/dist/scripts/generate-root-files.js

@@ -0,0 +1,759 @@
+import * as fs from "fs";
+import * as path from "path";
+export function generateRootFiles(projectDir, projectName) {
+    const tsconfig = {
+        compilerOptions: {
+            module: "nodenext",
+            moduleResolution: "nodenext",
+            resolvePackageJsonExports: true,
+            esModuleInterop: true,
+            isolatedModules: true,
+            declaration: true,
+            removeComments: true,
+            emitDecoratorMetadata: true,
+            experimentalDecorators: true,
+            allowSyntheticDefaultImports: true,
+            target: "ES2023",
+            sourceMap: true,
+            rootDir: ".",
+            outDir: "./dist",
+            types: ["node"],
+            incremental: true,
+            skipLibCheck: true,
+            strictNullChecks: true,
+            forceConsistentCasingInFileNames: true,
+            noImplicitAny: false,
+            strictBindCallApply: false,
+            noFallthroughCasesInSwitch: false,
+        },
+        include: ["src", "server.ts", "prisma.config.ts"],
+        exclude: ["node_modules"],
+    };
+    fs.writeFileSync(path.join(projectDir, "tsconfig.json"), JSON.stringify(tsconfig, null, 2));
+    const packageJson = {
+        name: projectName.toLowerCase().replace(/\s+/g, "-"),
+        "version": "1.0.0",
+        "description": "Cryptdox generated expressJS backend.",
+        "keywords": [
+            "ts"
+        ],
+        "homepage": "https://github.com/..#readme",
+        "bugs": {
+            "url": "https://github.com/../issues"
+        },
+        "repository": {
+            "type": "git",
+            "url": "git+https://github.com/...git"
+        },
+        "license": "ISC",
+        "author": "abir-hosen",
+        "main": "server.ts",
+        "scripts": {
+            "copy-locales": "cpx \"src/locales/**/*\" dist/src/locales",
+            "dev": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' server.ts",
+            "build": "tsc && npm run copy-locales",
+            "start": "node dist/server.js",
+            "test": "echo \"Error: no test specified\" && exit 1",
+            "generate-module": "ts-node scripts/generate-module.ts"
+        },
+        "dependencies": {
+            "@prisma/adapter-pg": "^7.3.0",
+            "@prisma/client": "^7.3.0",
+            "acorn": "^8.15.0",
+            "acorn-walk": "^8.3.4",
+            "arg": "^4.1.3",
+            "bcrypt": "^6.0.0",
+            "cors": "^2.8.6",
+            "create-require": "^1.1.1",
+            "diff": "^4.0.4",
+            "dotenv": "^17.2.3",
+            "express": "^5.2.1",
+            "i18next": "^25.8.4",
+            "i18next-fs-backend": "^2.6.1",
+            "i18next-http-middleware": "^3.9.2",
+            "jsonwebtoken": "^9.0.3",
+            "make-error": "^1.3.6",
+            "morgan": "^1.10.1",
+            "pg": "^8.18.0",
+            "redis": "^5.11.0",
+            "swagger-jsdoc": "^6.2.8",
+            "swagger-ui-express": "^5.0.1",
+            "undici-types": "^7.16.0",
+            "v8-compile-cache-lib": "^3.0.1",
+            "winston": "^3.19.0",
+            "yn": "^3.1.1",
+            "zod": "^4.3.6"
+        },
+        "devDependencies": {
+            "@types/bcrypt": "^6.0.0",
+            "@types/cors": "^2.8.19",
+            "@types/express": "^5.0.6",
+            "@types/i18next": "^12.1.0",
+            "@types/jsonwebtoken": "^9.0.10",
+            "@types/morgan": "^1.9.10",
+            "@types/node": "^25.1.0",
+            "@types/swagger-jsdoc": "^6.0.4",
+            "@types/swagger-ui-express": "^4.1.8",
+            "cpx": "^1.5.0",
+            "nodemon": "^3.1.11",
+            "prisma": "^7.3.0",
+            "ts-node": "^10.9.2",
+            "typescript": "^5.9.3"
+        }
+    };
+    fs.writeFileSync(path.join(projectDir, "package.json"), JSON.stringify(packageJson, null, 2));
+    const nodemon = {
+        watch: ["src"],
+        ext: "ts",
+        ignore: ["dist"],
+        exec: "ts-node server.ts",
+    };
+    fs.writeFileSync(path.join(projectDir, "nodemon.json"), JSON.stringify(nodemon, null, 2));
+    const gitignore = `
+node_modules
+.env
+dist
+package-lock.json
+pnpm-lock.yaml
+  `;
+    fs.writeFileSync(path.join(projectDir, ".gitignore"), gitignore.trim());
+    generatePrisma(projectDir);
+    generatePrismaConfig(projectDir);
+    generateEnvironmentAndDocker(projectDir);
+    generateReadme(projectDir, projectName);
+    console.log(`✅ root config files generated for project: ${projectName}`);
+}
+/* ================= PRISMA ================= */
+function generatePrisma(projectDir) {
+    const prismaDir = path.join(projectDir, "prisma");
+    if (!fs.existsSync(prismaDir))
+        fs.mkdirSync(prismaDir, { recursive: true });
+    const schema = `
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+// Looking for ways to speed up your queries, or scale easily with your serverless or edge functions?
+// Try Prisma Accelerate: https://pris.ly/cli/accelerate-init
+
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgresql"
+}
+
+model Common {
+  commonId String @id @default(uuid())
+  name     String @unique
+}
+`;
+    fs.writeFileSync(path.join(prismaDir, "schema.prisma"), schema.trim());
+}
+/* ================= PRISMA CONFIG ================= */
+function generatePrismaConfig(projectDir) {
+    const config = `
+// This file was generated by Prisma, and assumes you have installed the following:
+// npm install --save-dev prisma dotenv
+
+import "dotenv/config";
+import { defineConfig } from "prisma/config";
+
+export default defineConfig({
+  schema: "prisma/schema.prisma",
+  migrations: { path: "prisma/migrations" },
+  datasource: { url: process.env["DATABASE_URL"] },
+});
+  `;
+    fs.writeFileSync(path.join(projectDir, "prisma.config.ts"), config.trim());
+}
+/* ================= ENV & DOCKER CONFIG ================= */
+function generateEnvironmentAndDocker(projectDir) {
+    /* ================= ENV FILES ================= */
+    const baseEnv = `
+PORT=3000
+DATABASE_URL=postgresql://postgres:postgres@localhost:5433/app_db?pgbouncer=true
+IAM_REDIS_URL=redis://localhost:6380
+`.trim();
+    const envDev = `
+PORT=3000
+DATABASE_URL=postgresql://postgres:postgres@postgres:5433/app_db?pgbouncer=true
+IAM_REDIS_URL=redis://redis:6380
+`.trim();
+    const envProd = `
+PORT=3000
+DATABASE_URL=postgresql://postgres:strongpassword@postgres:5433/app_db?pgbouncer=true
+IAM_REDIS_URL=redis://redis:6380
+`.trim();
+    const exampleEnv = `
+PORT=
+DATABASE_URL=
+IAM_REDIS_URL=
+`.trim();
+    fs.writeFileSync(path.join(projectDir, ".env"), baseEnv);
+    fs.writeFileSync(path.join(projectDir, ".env.local"), baseEnv);
+    fs.writeFileSync(path.join(projectDir, ".env.dev"), envDev);
+    fs.writeFileSync(path.join(projectDir, ".env.prod"), envProd);
+    fs.writeFileSync(path.join(projectDir, "example.env"), exampleEnv);
+    /* ================= DOCKERFILE ================= */
+    const dockerfile = `
+FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package.json pnpm-lock.yaml* ./
+
+RUN npm install -g pnpm
+RUN pnpm install
+
+COPY . .
+
+RUN pnpm build
+
+EXPOSE 3000
+
+CMD ["node", "dist/server.js"]
+`.trim();
+    fs.writeFileSync(path.join(projectDir, "Dockerfile"), dockerfile);
+    /* ================= DOCKER COMPOSE ================= */
+    const dockerCompose = `
+version: "3.9"
+
+services:
+  app:
+    build: .
+    container_name: express_app
+    ports:
+      - "3001:3000"
+    env_file:
+      - .env.dev
+    depends_on:
+      - postgres
+      - redis
+    restart: always
+
+  postgres:
+    image: postgres:16
+    container_name: postgres_db
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: app_db
+    ports:
+      - "5433:5432"
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    restart: always
+
+  redis:
+    image: redis:7
+    container_name: redis_cache
+    ports:
+      - "6380:6379"
+    restart: always
+
+  iam:
+    image: abir71hosen/crypt-iam:latest
+    container_name: crypt_iam
+    depends_on:
+      - postgres
+      - redis
+    environment:
+      DATABASE_URL: postgres://postgres:postgres@postgres:5432/iam_db
+      IAM_REDIS_URL: redis://redis:6379
+      JWT_SECRET: supersecret
+      EXPOSE_PORT: 5000
+    ports:
+      - "5000:3000"
+
+volumes:
+  pgdata:
+`.trim();
+    fs.writeFileSync(path.join(projectDir, "docker-compose.yml"), dockerCompose);
+    console.log("✅ ENV and Docker files generated");
+}
+/* ================= README.MD ================= */
+function generateReadme(projectDir, projectName) {
+    const readmeContent = `
+> ✅ This ${projectName.toUpperCase()} project was generated using \`crypt-express-app\`
+> ✅ It includes Express + TypeScript + Prisma + Redis + Swagger + Docker + IAM
+> ✅ It explains how to run THIS generated app
+
+You can directly place this inside:
+
+\`\`\`
+${projectName}/README.md
+\`\`\`
+
+---
+
+
+# ${projectName.toUpperCase()}
+
+🚀 Scalable Express + TypeScript Backend Application  
+Generated using **crypt-express-app**
+
+---
+
+## 📌 About This Project
+
+This is a production-ready backend application scaffolded using the \`crypt-express-app\` CLI.
+
+It provides a clean, modular, and scalable architecture with:
+
+- Express + TypeScript
+- Prisma ORM
+- PostgreSQL
+- Redis
+- Swagger API documentation
+- Internationalization (i18n)
+- Docker support
+- IAM integration
+- Structured logging
+- Global error handling
+
+This project is designed to help you start building business logic immediately without worrying about boilerplate setup.
+
+---
+
+# 🏗 Architecture Overview
+
+This project follows a modular and scalable architecture.
+
+\`\`\`
+
+${projectName}\/
+│
+├── src\/
+│   ├── app.ts
+│   ├── routes.ts
+│   ├── prisma\/
+│   │   └── client.ts
+│   ├── modules\/
+│   ├── middlewares\/
+│   ├── utils\/
+│   ├── locales\/
+│
+├── prisma\/
+│   └── schema.prisma
+│
+├── server.ts
+├── docker-compose.yml
+├── Dockerfile
+├── .env
+├── .env.dev
+├── .env.prod
+└── package.json
+\`\`\`
+
+
+
+---
+
+## 📂 Folder Explanation
+
+### \`src\/app.ts\`
+Initializes Express app:
+- Middleware registration
+- Swagger setup
+- i18n initialization
+- Global error handling
+
+### \`src\/routes.ts\`
+Registers all feature module routes.
+
+### \`src\/modules\/\`
+Feature-based module structure.
+Each module should contain:
+- route
+- controller
+- service
+- validation (optional)
+
+### \`src\/prisma\/\`
+Prisma client initialization layer.
+
+### \`prisma\/schema.prisma\`
+Database schema definition.
+
+### \`src\/middlewares\/\`
+- Logger middleware
+- Error handler middleware
+
+### \`src\/locales\/\`
+Translation JSON files for:
+- English
+- Bengali
+
+---
+
+# 🚀 How To Run This Project
+
+---
+
+# 🧠 Important: First-Time IAM Setup
+
+If using IAM service, after running docker compose:
+
+You must run the IAM setup command ONE TIME:
+
+\`\`\`bash
+docker compose up -d postgres
+
+docker exec -it postgres_db createdb -U postgres iam_db || true
+\`\`\`
+
+This initializes:
+
+* IAM database
+* Default configuration
+* Required internal tables
+
+You only need to run this once.
+
+---
+
+# 🐳 Option 1: Run Using Docker (Recommended)
+
+## Step 1: Start Infrastructure
+
+\`\`\`bash
+docker compose up -d
+\`\`\`\`
+
+---
+
+## Services Included
+
+| Service  | Description                |
+| -------- | -------------------------- |
+| app      | Express backend            |
+| postgres | PostgreSQL database        |
+| redis    | Redis cache                |
+| iam      | IAM authentication service |
+
+---
+
+## Port Mapping
+
+| Service    | Host Port | Container Port |
+| ---------- | --------- | -------------- |
+| App        | 3001      | 3000           |
+| PostgreSQL | 5433      | 5432           |
+| Redis      | 6380      | 6379           |
+| IAM        | 5000      | 3000           |
+
+
+If running via Docker:
+
+\`\`\`
+http://localhost:3001
+\`\`\`
+
+---
+
+# 💻 Option 2: Run App Locally (Recommended for Development)
+
+### 1️⃣ Start Database & Redis
+
+\`\`\`bash
+docker compose up -d postgres redis iam
+\`\`\`
+
+---
+
+### 2️⃣ Install Dependencies
+
+\`\`\`bash
+pnpm install
+\`\`\`
+
+or
+
+\`\`\`bash
+npm install
+\`\`\`
+
+---
+
+### 3️⃣ Generate Prisma Client
+
+\`\`\`bash
+npx prisma generate
+\`\`\`
+
+---
+
+### 4️⃣ Run Migrations (First Time Only)
+
+\`\`\`bash
+npx prisma db push
+\`\`\`
+
+---
+
+### 5️⃣ Start Development Server
+
+\`\`\`bash
+pnpm dev
+\`\`\`
+
+or
+
+\`\`\`bash
+npm run dev
+\`\`\`
+
+---
+
+Server will run at:
+
+\`\`\`
+http://localhost:3000
+\`\`\`
+
+---
+
+# 📖 Swagger API Documentation
+
+Access App Swagger UI at:
+
+\`\`\`
+http://localhost:3000/api/docs
+\`\`\`
+
+or Docker:
+
+\`\`\`
+http://localhost:3001/api/docs
+\`\`\`
+
+
+Access IAM Swagger UI at:
+
+\`\`\`
+http://localhost:5000/api/docs
+\`\`\`
+
+
+Get IAM master realm id to login:
+
+\`\`\`
+docker exec -it postgres_db psql -U postgres -d iam_db
+SELECT * FROM realm;
+q
+\\q
+\`\`\`
+
+
+Features:
+
+* Interactive API testing
+* Bearer token authentication
+* Request/response schema
+* Try-it-out functionality
+
+---
+
+# 🌍 Internationalization (i18n)
+
+Supported languages:
+
+* English
+* Bengali
+
+Translation files located in:
+
+\`\`\`
+src\/locales\/
+\`\`\`
+
+Language is detected automatically via request headers.
+
+---
+
+# 🧠 Environment Configuration
+
+## \`.env\` (Local)
+
+\`\`\`
+PORT=3000
+DATABASE_URL=postgresql:\/\/postgres:postgres@localhost:5432\/app_db?pgbouncer=true
+IAM_REDIS_URL=redis:\/\/localhost:6379
+\`\`\`
+
+---
+
+# 🗄 Database Configuration
+
+Database: PostgreSQL
+ORM: Prisma
+
+Schema file:
+
+\`\`\`
+prisma\/schema.prisma
+\`\`\`
+
+After updating schema:
+
+\`\`\`bash
+npx prisma migrate dev
+npx prisma generate
+\`\`\`
+
+---
+
+# ⚡ Redis Cache
+
+Redis is used for:
+
+* Caching
+* Performance optimization
+* Session storage (optional)
+* Token storage (optional)
+
+Redis URL is configured via:
+
+\`\`\`
+IAM_REDIS_URL
+\`\`\`
+
+---
+
+# 🔐 IAM Integration
+
+This project includes optional IAM service:
+
+* Authentication
+* Authorization
+* JWT management
+* Token validation
+
+IAM runs on:
+
+\`\`\`
+http:\/\/localhost:5000
+\`\`\`
+
+Make sure IAM setup is completed before using protected endpoints.
+
+---
+
+# 🧱 Adding New Module
+
+From root run:
+
+\`\`\`
+pnpm generate-module example
+\`\`\`
+
+Inside:
+
+\`\`\`
+src\/modules\/
+\`\`\`
+
+Create:
+
+\`\`\`
+example\/
+  example.route.ts
+  example.controller.ts
+  example.service.ts
+  example.middleware.ts
+  example.dto.ts
+\`\`\`
+
+Register route in:
+
+\`\`\`
+routes.ts
+\`\`\`
+
+Follow clean separation:
+
+* Controller handles request\/response
+* Service handles business logic
+
+---
+
+# 🛠 Available Scripts
+
+\`\`\`
+pnpm dev
+pnpm build
+pnpm start
+\`\`\`
+
+| Script | Purpose              |
+| ------ | -------------------- |
+| dev    | Development mode     |
+| build  | Compile TypeScript   |
+| start  | Run production build |
+
+---
+
+# 🔐 Production Deployment
+
+Recommended:
+
+* Use \`.env.\`
+* Secure database credentials
+* Use reverse proxy (NGINX)
+* Enable SSL
+* Use Docker Compose
+* Monitor logs
+
+---
+
+# 🧪 Best Practices
+
+* Keep modules small
+* Avoid business logic in controllers
+* Use service layer properly
+* Validate inputs
+* Handle errors centrally
+* Use environment-based config
+
+---
+
+# 📄 License
+
+ISC
+
+---
+
+# 👨‍💻 Generated With
+
+This project was generated using:
+
+crypt-express-app
+
+Production-ready Express backend scaffolding CLI.
+
+---
+
+# 🚀 Now What?
+
+You can now:
+
+* Add business logic
+* Build APIs
+* Connect frontend
+* Implement module authorization
+* Deploy to production
+
+Happy coding 🚀 
+
+## 🔗 Links
+
+- 🌐 Website: [Cryptdox](https://cryptdox.com)
+- 📦 NPM Package: [crypt-express-app](https://www.npmjs.com/package/crypt-express-app)
+- 👤 Portfolio: [abir.cryptdox.com](http://abir.cryptdox.com)
+- 📧 Email: abir71.hosen@gmail.com
+ 
+`.trim();
+    fs.writeFileSync(path.join(projectDir, "README.md"), readmeContent);
+    console.log("✅ Readme.md file generated");
+}