@urbansolv/create-nestjs-app 1.0.0

package/README.md

@@ -0,0 +1,121 @@
+# @urbansolv/create-nestjs-app
+
+Official CLI tool to scaffold Urbansolv NestJS applications with built-in RBAC, Prisma ORM, and best practices.
+
+## Features
+
+✅ Complete NestJS boilerplate following Urbansolv standards
+✅ Role-Based Access Control (RBAC) pre-configured
+✅ Prisma ORM with PostgreSQL
+✅ JWT Authentication
+✅ Auto-generated Swagger documentation
+✅ Production-ready structure
+✅ Comprehensive seed data
+✅ Testing setup included
+
+## Quick Start
+```bash
+# Using npx (recommended)
+npx @urbansolv/create-nestjs-app my-app
+
+# Using npm
+npm init @urbansolv/nestjs-app my-app
+
+# Using yarn
+yarn create @urbansolv/nestjs-app my-app
+```
+
+## Usage
+```bash
+create-urbansolv-app [project-name] [options]
+
+Options:
+  -p, --package-manager <manager>  Package manager to use (npm, yarn, pnpm)
+  -d, --database <name>            Database name
+  --skip-install                   Skip package installation
+  -h, --help                       Display help
+  -V, --version                    Display version
+```
+
+## Examples
+```bash
+# Create app with default settings
+npx @urbansolv/create-nestjs-app my-awesome-app
+
+# Create app with yarn and custom database
+npx @urbansolv/create-nestjs-app my-app -p yarn -d my_database
+
+# Create app without installing dependencies
+npx @urbansolv/create-nestjs-app my-app --skip-install
+```
+
+## After Installation
+```bash
+cd my-app
+
+# Copy environment variables
+cp .env.example .env
+
+# Edit .env with your database credentials
+
+# Run migrations
+npm run prisma:migrate
+
+# Seed database
+npm run prisma:seed
+
+# Start development server
+npm run start:dev
+```
+
+## Default Credentials
+
+After seeding:
+
+**Admin:**
+- Email: admin@urbansolv.co.id
+- Password: password123
+
+**Member:**
+- Email: member@urbansolv.co.id
+- Password: password123
+
+## Documentation
+
+For full documentation, visit: [Urbansolv Documentation](https://docs.urbansolv.co.id)
+
+## Support
+
+- Issues: https://github.com/godwimp/create-nestjs-app/issues
+- Email: support@urbansolv.co.id
+
+## License
+
+MIT © Urbansolv
+```
+
+### 22.5 LICENSE File
+
+**urbansolv-nestjs-cli/LICENSE**
+```
+MIT License
+
+Copyright (c) 2024 Urbansolv
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.mjs

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { CreateCommand } from "./commands/create.js";
+const program = new Command();
+program
+    .name('urbansolv-nest')
+    .description('CLI to generate Urbansolv NestJS boilerplate projects')
+    .version('1.0.0');
+program
+    .argument('[project-name', 'Name of the project')
+    .option('-p, --package-manager <manager>', 'Package manager to use (npm, yarn, pnpm)')
+    .option('-d, --database <name>', 'Database name')
+    .option('--skip-install', 'Skip package installation')
+    .action(async (projectName, options) => {
+    const createCommand = new CreateCommand();
+    await createCommand.execute(projectName, options);
+});
+program.parse();

package/dist/commands/create.d.ts

@@ -0,0 +1,12 @@
+export interface CreateOptions {
+    projectName: string;
+    database?: string;
+    packageManager?: "npm" | "yarn" | "pnpm";
+    skipInstall?: boolean;
+}
+export declare class CreateCommand {
+    execute(projectName?: string, options?: Partial<CreateOptions>): Promise<void>;
+    private createProject;
+    private installDependencies;
+    private printSuccessMessage;
+}

package/dist/commands/create.js

@@ -0,0 +1,103 @@
+import inquirer from "inquirer";
+import ora from "ora";
+import path from "path";
+import { execSync } from "child_process";
+import { FileUtils } from "../utils/file-utils.js";
+import { Logger } from "../utils/logger.js";
+import { fileURLToPath } from "url";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export class CreateCommand {
+    async execute(projectName, options) {
+        Logger.title("Urbansolv NestJS Boilerplate Generator");
+        const answers = await inquirer.prompt([
+            {
+                type: "input",
+                name: "projectName",
+                message: "Project name:",
+                default: projectName || "my-urbansolv-app",
+                when: !projectName,
+            },
+            {
+                type: "list",
+                name: "packageManager",
+                message: "Package manager:",
+                choices: ["npm", "yarn", "pnpm"],
+                default: options?.packageManager || "npm",
+                when: !options?.packageManager,
+            },
+            {
+                type: "input",
+                name: "database",
+                message: "Database name:",
+                default: "urbansolv_db",
+                when: !options?.database,
+            },
+            {
+                type: "confirm",
+                name: "skipInstall",
+                message: "Skip package installation?",
+                default: false,
+                when: !options?.skipInstall === undefined,
+            },
+        ]);
+        const config = {
+            projectName: projectName || answers.projectName,
+            database: options?.database || answers.database,
+            packageManager: options?.packageManager || answers.packageManager,
+            skipInstall: options?.skipInstall ?? answers.skipInstall,
+        };
+        await this.createProject(config);
+    }
+    async createProject(config) {
+        const targetPath = path.join(process.cwd(), config.projectName);
+        if (await FileUtils.fileExists(targetPath)) {
+            Logger.error(`Directory ${config.projectName} already exists!`);
+            process.exit(1);
+        }
+        const spinner = ora("Creating project structure...").start();
+        try {
+            const templatePath = path.join(__dirname, "../../templates/nestjs-app");
+            await FileUtils.copyTemplate(templatePath, targetPath, {
+                __PROJECT_NAME__: config.projectName,
+                __DATABASE_NAME__: config.database || "urbansolv_db",
+            });
+            spinner.succeed("Project structure created.");
+            if (!config.skipInstall) {
+                await this.installDependencies(targetPath, config.packageManager);
+            }
+            this.printSuccessMessage(config);
+        }
+        catch (error) {
+            spinner.fail("Failed to create project.");
+            Logger.error(error instanceof Error ? error.message : "Unknown error");
+            process.exit(1);
+        }
+    }
+    async installDependencies(projectPath, packageManager) {
+        const spinner = ora("Installing dependencies...").start();
+        try {
+            execSync(`cd ${projectPath} && ${packageManager} install`, {
+                stdio: "inherit",
+            });
+            spinner.succeed("Dependencies installed.");
+        }
+        catch (error) {
+            spinner.fail("Failed to install dependencies.");
+            Logger.warning("You can install them manually later.");
+        }
+    }
+    async printSuccessMessage(config) {
+        Logger.success("\n Project Created Successfully! \n");
+        Logger.info("Next Steps:\n");
+        console.log(`  cd ${config.projectName}`);
+        if (config.skipInstall) {
+            console.log(`  ${config.packageManager} install`);
+        }
+        console.log(`  cp .env.example .env`);
+        console.log(`  # Update your .env file with database credentials`);
+        console.log(`  npx prisma migrate dev`);
+        console.log(`  npx prisma db seed`);
+        console.log(`  npm run start:dev\n`);
+    }
+}

package/dist/templates/nestjs-app/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

package/dist/templates/nestjs-app/.env.example

@@ -0,0 +1,24 @@
+# Application
+NODE_ENV=development
+PORT=3000
+APP_NAME=__PROJECT_NAME__
+
+# Database
+DATABASE_URL="postgresql://username:password@localhost:5432/__DATABASE_NAME__?schema=public"
+
+# JWT
+JWT_SECRET=your-super-secret-jwt-key-change-this-in-production
+JWT_EXPIRATION=7d
+JWT_REFRESH_SECRET=your-super-secret-refresh-key-change-this-in-production
+JWT_REFRESH_EXPIRATION=30d
+
+# CORS
+CORS_ORIGIN=http://localhost:3001
+
+# API
+API_PREFIX=api
+API_VERSION=v1
+
+# Swagger
+SWAGGER_ENABLED=true
+SWAGGER_PATH=api-docs

package/dist/templates/nestjs-app/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

package/dist/templates/nestjs-app/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
+  "printWidth": 100,
+  "arrowParens": "always"
+}

package/dist/templates/nestjs-app/README.md

@@ -0,0 +1,133 @@
+# Urbansolv NestJS Backend
+
+Backend application built with NestJS following Urbansolv standardization manual.
+
+## Features
+
+- 🔐 JWT Authentication with RBAC
+- 📝 Complete User Management
+- 🎯 Permission-based Access Control
+- 📚 Auto-generated Swagger Documentation
+- ✅ Input Validation
+- 🔄 API Versioning
+- 📊 Structured Logging
+- 🗃️ Prisma ORM with PostgreSQL
+- 🧪 Testing Setup (Unit & E2E)
+
+## Prerequisites
+
+- Node.js >= 18.x
+- PostgreSQL >= 14.x
+- npm/yarn/pnpm
+
+## Installation
+```bash
+# Install dependencies
+npm install
+
+# Setup environment variables
+cp .env.example .env
+# Edit .env with your database credentials
+
+# Generate Prisma Client
+npm run prisma:generate
+
+# Run migrations
+npm run prisma:migrate
+
+# Seed database
+npm run prisma:seed
+```
+
+## Running the Application
+```bash
+# Development
+npm run start:dev
+
+# Production build
+npm run build
+npm run start:prod
+
+# Debug mode
+npm run start:debug
+```
+
+## Database Commands
+```bash
+# Generate Prisma Client
+npm run prisma:generate
+
+# Create migration
+npm run prisma:migrate
+
+# Seed database
+npm run prisma:seed
+
+# Open Prisma Studio
+npm run prisma:studio
+```
+
+## Testing
+```bash
+# Unit tests
+npm run test
+
+# E2E tests
+npm run test:e2e
+
+# Test coverage
+npm run test:cov
+```
+
+## API Documentation
+
+After starting the application, visit:
+- Swagger UI: `http://localhost:3000/api-docs`
+
+## Default Users
+
+After seeding the database:
+
+**Admin User:**
+- Email: `admin@urbansolv.com`
+- Password: `password123`
+- All permissions granted
+
+**Member User:**
+- Email: `member@urbansolv.com`
+- Password: `password123`
+- Limited permissions (VIEW_USER only)
+
+## Project Structure
+```
+src/
+├── common/              # Shared resources
+│   ├── decorators/      # Custom decorators
+│   ├── filters/         # Exception filters
+│   ├── guards/          # Auth & permission guards
+│   ├── interceptors/    # Logging & transform
+│   ├── prisma/          # Prisma service
+│   └── utils/           # Helper functions
+├── config/              # Configuration files
+├── modules/             # Feature modules
+│   ├── auth/            # Authentication
+│   ├── users/           # User management
+│   └── health/          # Health checks
+├── app.module.ts        # Root module
+└── main.ts              # Application entry point
+```
+
+## Environment Variables
+
+See `.env.example` for all available configuration options.
+
+## License
+
+Proprietary - Urbansolv
+```
+
+### 20.2 .gitkeep for migrations
+
+**templates/nestjs-app/prisma/migrations/.gitkeep**
+```
+# This file keeps the migrations directory in git

package/dist/templates/nestjs-app/nest-cli.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "webpack": true,
+    "tsConfigPath": "tsconfig.json"
+  }
+}

package/dist/templates/nestjs-app/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "__PROJECT_NAME__",
+  "version": "1.0.0",
+  "description": "Urbansolv NestJS Application",
+  "author": "Urbansolv",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "prisma:generate": "prisma generate",
+    "prisma:migrate": "prisma migrate dev",
+    "prisma:studio": "prisma studio",
+    "prisma:seed": "ts-node prisma/seed.ts"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/passport": "^11.0.5",
+    "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/swagger": "^11.2.3",
+    "@prisma/client": "^6.19.0",
+    "bcryptjs": "^3.0.3",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "joi": "^18.0.2",
+    "passport": "^0.7.0",
+    "passport-jwt": "^4.0.1",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^11.0.0",
+    "@nestjs/schematics": "^11.0.0",
+    "@nestjs/testing": "^11.0.1",
+    "@types/bcrypt": "^6.0.0",
+    "@types/express": "^5.0.5",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.7",
+    "@types/passport-jwt": "^4.0.1",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.2",
+    "jest": "^30.0.0",
+    "prettier": "^3.4.2",
+    "prisma": "^6.19.0",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3"
+  },
+  "prisma": {
+    "seed": "ts-node prisma/seed.ts"
+  },
+  "jest": {
+    "moduleFileExtensions": ["js", "json", "ts"],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": ["**/*.(t|j)s"],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/dist/templates/nestjs-app/prisma/schema.prisma

@@ -0,0 +1,79 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
+}
+
+// ============================================
+// RBAC Schema
+// ============================================
+
+model User {
+  id         Int       @id @default(autoincrement())
+  email      String    @unique
+  password   String
+  first_name String
+  last_name  String
+  is_active  Boolean   @default(true)
+  created_at DateTime  @default(now())
+  updated_at DateTime  @updatedAt
+  deleted_at DateTime?
+
+  // Relations
+  position_id Int
+  position    Position @relation(fields: [position_id], references: [id])
+
+  @@map("users")
+}
+
+model Position {
+  id          Int       @id @default(autoincrement())
+  name        String    @unique
+  description String?
+  is_active   Boolean   @default(true)
+  created_at  DateTime  @default(now())
+  updated_at  DateTime  @updatedAt
+  deleted_at  DateTime?
+
+  // Relations
+  users               User[]
+  position_permissions PositionPermission[]
+
+  @@map("positions")
+}
+
+model Permission {
+  id          Int       @id @default(autoincrement())
+  name        String    @unique
+  description String?
+  resource    String // e.g., 'USER', 'TRANSACTION', 'REPORT'
+  action      String // e.g., 'VIEW', 'ADD', 'UPDATE', 'DELETE'
+  created_at  DateTime  @default(now())
+  updated_at  DateTime  @updatedAt
+  deleted_at  DateTime?
+
+  // Relations
+  position_permissions PositionPermission[]
+
+  @@map("permissions")
+}
+
+model PositionPermission {
+  id            Int      @id @default(autoincrement())
+  position_id   Int
+  permission_id Int
+  created_at    DateTime @default(now())
+
+  // Relations
+  position   Position   @relation(fields: [position_id], references: [id], onDelete: Cascade)
+  permission Permission @relation(fields: [permission_id], references: [id], onDelete: Cascade)
+
+  @@unique([position_id, permission_id])
+  @@map("position_permissions")
+}