@kuldi/create-nestjs 1.1.1 → 1.1.3

package/README.md

@@ -1,27 +1,39 @@
-# @kuldi/create-nestjs
+<div align="center">
+  <h1>🚀 @kuldi/create-nestjs</h1>
+  <p>The official, interactive, and lightning-fast scaffolding tool for <b>Kuli Digital's NestJS Boilerplate</b>.</p>
+</div>
 
-The official interactive scaffolding tool for Kuli Digital's NestJS Boilerplate.
+---
 
-## Quick Start
+## ✨ Features
 
-To generate a new NestJS project using this boilerplate, simply run:
+- **⚡️ Instant Setup**: Scaffold a production-ready NestJS architecture in seconds.
+- **🛠 Interactive Prompts**: Easily configure your project name, database name, and package manager.
+- **🔐 Auto-Configured Environment**: Automatically generates a tailored `.env` file for your database credentials.
+- **🏗 Production Ready**: Comes pre-configured with Prisma ORM, Swagger Documentation, JWT Auth, and RBAC (Role-Based Access Control) out of the box.
+
+## 🚀 Quick Start
+
+To generate a new NestJS project, use the `@latest` tag to ensure you get the most recent version of the boilerplate:
 
 ```bash
-npm create @kuldi/nestjs my-app
+npm create @kuldi/nestjs@latest my-app
 ```
 
-Or, to create it in the current directory:
+Or, to create the project in your **current directory**:
 
 ```bash
-npm create @kuldi/nestjs .
+npm create @kuldi/nestjs@latest .
 ```
 
-## Features
+### Note on Global Installations (Optional)
+If you prefer installing the package globally, you can do so, but using `npm create` (or `npx`) is highly recommended to always fetch the latest updates.
 
-- **Interactive Prompts**: Easily configure your project name and database name.
-- **Auto-Configured Environment**: Automatically generates a `.env` file tailored to your database credentials.
-- **Production Ready**: Scaffolds a full-fledged NestJS architecture with Prisma, Swagger, and JWT Auth out of the box.
+```bash
+npm install -g @kuldi/create-nestjs
+create-nestjs my-app
+```
 
-## License
+## 📄 License
 
-MIT - Kuli Digital
+MIT © Kuli Digital

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@kuldi/create-nestjs",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "type": "module",
   "description": "Scaffolding tool for Kuli Digital NestJS Boilerplate",
   "main": "src/cli.js",
   "bin": {
-    "create-nestjs": "./src/cli.js"
+    "create-nestjs": "src/cli.js"
   },
   "files": [
     "src",

package/src/cli.js

@@ -24,20 +24,20 @@ async function run() {
     {
       type: 'input',
       name: 'projectName',
-      message: 'Nama Project (atau . untuk folder saat ini):',
+      message: 'Project Name (or . for current directory):',
       default: argProjectName || 'my-nestjs-app',
       when: !argProjectName,
     },
     {
       type: 'input',
       name: 'database',
-      message: 'Nama Database PostgreSQL:',
+      message: 'PostgreSQL Database Name:',
       default: 'kulidigital_db',
     },
     {
       type: 'confirm',
       name: 'skipInstall',
-      message: 'Lewati instalasi package (npm install)?',
+      message: 'Skip package installation (npm install)?',
       default: false,
     },
   ]);
@@ -49,37 +49,37 @@ async function run() {
   if (projectName === '.') {
     const files = fs.readdirSync(currentPath).filter(f => !f.startsWith('.git'));
     if (files.length > 0) {
-      console.log(chalk.red('\n❌ Folder saat ini tidak kosong! Harap jalankan di folder kosong.\n'));
+      console.log(chalk.red('\n❌ Current directory is not empty! Please run in an empty directory.\n'));
       process.exit(1);
     }
   }
 
   // 2. Salin Template
-  const copySpinner = ora('Membuat struktur project...').start();
+  const copySpinner = ora('Generating project structure...').start();
   try {
     const templateDir = path.join(__dirname, '../template');
     
-    // Copy seluruh isi folder template ke project tujuan
+    // Copy template contents to the target project directory
     fs.cpSync(templateDir, projectPath, { recursive: true });
     
-    // Rename gitignore menjadi .gitignore (krn NPM mengabaikan .gitignore saat publish)
+    // Rename gitignore to .gitignore (NPM ignores .gitignore during publish)
     const gitignorePath = path.join(projectPath, 'gitignore');
     if (fs.existsSync(gitignorePath)) {
       fs.renameSync(gitignorePath, path.join(projectPath, '.gitignore'));
     }
 
-    copySpinner.succeed('Struktur project berhasil dibuat.');
+    copySpinner.succeed('Project structure generated successfully.');
   } catch (error) {
-    copySpinner.fail('Gagal menyalin struktur template.');
+    copySpinner.fail('Failed to generate project structure.');
     console.error(error.message);
     process.exit(1);
   }
 
-  // Masuk ke folder project
+  // Navigate to project directory
   process.chdir(projectPath);
 
   // 3. Setup .env
-  const envSpinner = ora('Menyiapkan file .env...').start();
+  const envSpinner = ora('Configuring environment variables...').start();
   try {
     const envExamplePath = path.join(projectPath, '.env.example');
     const envPath = path.join(projectPath, '.env');
@@ -91,36 +91,36 @@ async function run() {
       envContent = envContent.replace(/APP_NAME=my-app/g, `APP_NAME=${projectName === '.' ? path.basename(currentPath) : projectName}`);
       
       fs.writeFileSync(envPath, envContent);
-      envSpinner.succeed('File .env berhasil dibuat.');
+      envSpinner.succeed('.env file created successfully.');
     } else {
-      envSpinner.warn('File .env.example tidak ditemukan, lewati setup .env.');
+      envSpinner.warn('.env.example not found, skipping .env setup.');
     }
   } catch (error) {
-    envSpinner.fail('Gagal menyiapkan file .env.');
+    envSpinner.fail('Failed to configure .env file.');
   }
   
-  // 4. Inisialisasi Git
+  // 4. Initialize Git
   try {
     execSync('git init', { stdio: 'ignore' });
   } catch (e) {
-    // Abaikan jika user tidak punya git terinstall
+    // Ignore if git is not installed
   }
 
   // 5. Install Dependencies
   if (!answers.skipInstall) {
-    const installSpinner = ora(`Menginstal dependencies menggunakan npm... (ini butuh waktu beberapa menit)`).start();
+    const installSpinner = ora(`Installing dependencies using npm... (this may take a few minutes)`).start();
     try {
       execSync(`npm install`, { stdio: 'ignore' });
-      installSpinner.succeed('Dependencies berhasil diinstal.');
+      installSpinner.succeed('Dependencies installed successfully.');
     } catch (error) {
-      installSpinner.fail('Gagal menginstal dependencies.');
-      console.log(chalk.yellow('\nKamu bisa menginstalnya secara manual nanti.'));
+      installSpinner.fail('Failed to install dependencies.');
+      console.log(chalk.yellow('\nYou can install them manually later.'));
     }
   }
 
   // 6. Success Message
-  console.log(chalk.green.bold('\n✅ Project Berhasil Dibuat!\n'));
-  console.log(chalk.white('Langkah selanjutnya:'));
+  console.log(chalk.green.bold('\n✅ Project successfully created!\n'));
+  console.log(chalk.white('Next steps:'));
   
   if (projectName !== '.') {
     console.log(chalk.cyan(`  cd ${projectName}`));

package/template/README.md

@@ -1,133 +1,137 @@
-# Kuli Digital NestJS Backend
-
-Backend application built with NestJS following Kuli Digital 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@kulidigital.com`
-- Password: `password123`
-- All permissions granted
-
-**Member User:**
-- Email: `member@kulidigital.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 - Kuli Digital
-```
-
-### 20.2 .gitkeep for migrations
-
-**templates/nestjs-app/prisma/migrations/.gitkeep**
-```
-# This file keeps the migrations directory in git
+<div align="center">
+  <h1>🏗 Kuli Digital NestJS Backend</h1>
+  <p>The standard backend application architecture built with NestJS following the <b>Kuli Digital Standardization Manual</b>.</p>
+</div>
+
+---
+
+## ✨ Features
+
+- 🔐 **JWT Authentication with RBAC**: Secure endpoints using Role-Based Access Control.
+- 📝 **Complete User Management**: Built-in user creation, login, and profile handling.
+- 🎯 **Permission-based Access Control**: Fine-grained authorization controls.
+- 📚 **Auto-generated Swagger Documentation**: Interactive API documentation available out of the box.
+- ✅ **Input Validation**: Strongly typed DTOs and parameter validation.
+- 🔄 **API Versioning**: Scalable route versioning (e.g., `/v1/...`).
+- 📊 **Structured Logging**: Pre-configured global interceptors for request/response logging.
+- 🗃️ **Prisma ORM with PostgreSQL**: Fully typed database access.
+- 🧪 **Testing Setup**: Ready-to-go Unit & E2E testing environments.
+
+## ⚙️ Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+- Node.js `>= 18.x`
+- PostgreSQL `>= 14.x`
+- npm, yarn, or pnpm
+
+## 🚀 Installation & Setup
+
+1. **Install dependencies:**
+```bash
+npm install
+```
+
+2. **Setup environment variables:**
+Your `.env` file should already be generated if you used the CLI tool. If not, copy it from the example:
+```bash
+cp .env.example .env
+```
+*(Ensure `DATABASE_URL` is correctly configured to point to your PostgreSQL database)*
+
+3. **Initialize the Database:**
+```bash
+# Generate Prisma Client
+npx prisma generate
+
+# Run migrations to create tables
+npx prisma migrate dev
+
+# Seed the database with default roles and users
+npx prisma db seed
+```
+
+## 💻 Running the Application
+
+```bash
+# Development mode (Hot-reload)
+npm run start:dev
+
+# Production build
+npm run build
+npm run start:prod
+
+# Debug mode
+npm run start:debug
+```
+
+## 🗄 Database Commands (Prisma)
+
+```bash
+# Generate Prisma Client (after pulling new schema changes)
+npx prisma generate
+
+# Create a new migration (after modifying schema.prisma)
+npx prisma migrate dev --name <migration_name>
+
+# Open Prisma Studio (GUI to view your database)
+npx prisma studio
+```
+
+## 🧪 Testing
+
+```bash
+# Run Unit tests
+npm run test
+
+# Run E2E tests
+npm run test:e2e
+
+# Run tests with coverage
+npm run test:cov
+```
+
+## 📖 API Documentation
+
+Once the application is running, you can access the Swagger UI documentation at:
+👉 **[http://localhost:3000/api-docs](http://localhost:3000/api-docs)**
+
+## 👥 Default Seeded Users
+
+If you ran `npx prisma db seed`, you can log in with the following default credentials:
+
+**👑 Admin User:**
+- Email: `admin@kulidigital.com`
+- Password: `password123`
+- *Privileges: All permissions granted*
+
+**👤 Member User:**
+- Email: `member@kulidigital.com`
+- Password: `password123`
+- *Privileges: Limited permissions (VIEW_USER only)*
+
+## 📂 Project Structure
+
+```text
+src/
+├── common/              # Shared resources across the app
+│   ├── constants/       # Global constants (e.g., Permissions)
+│   ├── decorators/      # Custom decorators (e.g., @GetUser)
+│   ├── dto/             # Shared DTOs (e.g., Pagination)
+│   ├── filters/         # Exception filters (e.g., HttpExceptionFilter)
+│   ├── guards/          # Auth & permission guards
+│   ├── helpers/         # Helper functions
+│   ├── interceptors/    # Logging & transform interceptors
+│   ├── prisma/          # Prisma module & service
+│   └── utils/           # Utility functions (e.g., Password hashing)
+├── config/              # Configuration files & Environment validation
+├── modules/             # Feature-specific modules
+│   ├── auth/            # Authentication logic & endpoints
+│   ├── users/           # User management logic & endpoints
+│   └── health/          # Health check endpoint
+├── app.module.ts        # Root module
+└── main.ts              # Application entry point
+```
+
+## 📄 License
+
+Proprietary - Kuli Digital