nestcraftx 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Augustin Selete
+
+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/bin/nestcraft.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+const [, , command] = process.argv;
+
+switch (command) {
+  case "start":
+    require("../commands/start")();
+    break;
+  case "--help":
+  case "-h":
+  default:
+    console.log(`
+🌟 Bienvenue sur NestCraftX CLI 🌟
+
+Usage :
+  npx nestcraftx start     Génère une structure NestJS Clean Architecture
+
+Exemples :
+  npx nestcraftx start
+
+📘 Plus de commandes à venir...
+`);
+    break;
+}

package/commands/start.js

@@ -0,0 +1,8 @@
+const path = require("path");
+
+module.exports = function () {
+  console.log("🚀 Lancement de la génération NestJS...");
+
+  const setupPath = path.join(__dirname, "..", "setup.js");
+  require(setupPath);
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "nestcraftx",
+  "version": "0.1.0",
+  "description": "CLI to generate scalable NestJS projects with Clean Architecture and Clean Code",
+  "main": "bin/nestcraft.js",
+  "bin": {
+    "nestcraftx": "./bin/nestcraft.js"
+  },
+  "scripts": {
+    "test": "nestcraftx test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/august-dev-pro/NestCraftX"
+  },
+  "keywords": [
+    "nestjs",
+    "cli",
+    "starter",
+    "generator",
+    "clean architecture",
+    "ddd",
+    "scaffold"
+  ],
+  "author": "Ablanhou Augustin Selete",
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {}
+}

package/readme

@@ -0,0 +1,181 @@
+## 🛠️ NestCraft — Générateur de projet backend NestJS
+
+![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Node.js](https://img.shields.io/badge/node-%3E=16.0.0-green.svg)
+
+Bienvenue dans **NestCraft**, un CLI Node.js puissant pour générer automatiquement une structure de projet backend modulaire, professionnelle et maintenable. Il s’appuie sur les meilleures pratiques modernes : **Clean Architecture**, **Domain-Driven Design (DDD)**, **Prisma**, **TypeORM**, **JWT Auth**, **Swagger**, **Docker**, etc.
+
+> 🧠 L’objectif ? Ne plus jamais repartir de zéro pour créer une base de projet solide, évolutive et prête pour la production.
+
+---
+
+## 📑 Sommaire
+
+    - [✨ Objectif du projet](#-objectif-du-projet)
+    - [📦 Prérequis](#-prérequis)
+    - [🚀 Installation et utilisation](#-installation-et-utilisation)
+    - [🧰 Ce que la commande configure automatiquement](#-Ce-que-la-commande-configure-automatiquement)
+    - [📁 Exemple d’architecture générée](#-exemple-darchitecture-générée)
+    - [📌 À venir](#-à-venir)
+    - [❤️ Contribuer](#️-contribuer)
+    - [📜 Licence](#-licence)
+
+---
+
+## ✨ Objectif du projet
+
+    L’idée est simple : au lieu de réinventer la roue à chaque projet, ce CLI vous génère une base de code solide, bien organisée et évolutive en quelques minutes. Cela vous permet de :
+
+    - Démarrer un nouveau projet rapidement
+    - Avoir une structure claire dès le départ
+    - Uniformiser vos projets
+    - Se concentrer sur la logique métier sans perdre de temps sur la configuration
+
+---
+
+## 📦 Prérequis
+
+    Assurez-vous d’avoir :
+
+    - **Node.js** v16 ou supérieur
+    - **npm** ou **yarn**
+    - **Docker** (pour l intégration avec la base de données)
+    - **Git** (optionnel pour init un repo)
+
+
+---```bash
+
+## 🚀 Installation et utilisation
+
+    💻 Installation locale (développement ou usage temporaire)
+
+    git clone https://github.com/august-dev-pro/nestcraft
+    cd nestcraft
+    npm install
+    node setup.js
+---
+
+## 🧰 Ce que la commande configure automatiquement :
+
+    ✅ Structure Clean Architecture (domain/usecases/infra)
+
+    ✅ Swagger (documentation automatique)
+
+    ✅ Authentification JWT (optionnelle)
+
+    ✅ Prisma ou TypeORM
+
+    ✅ Docker + docker-compose
+
+    ✅ Logger personnalisés (logSuccess, logError, etc.)
+
+    ✅ Setup .env, Prisma schema, et plus encore...
+
+---
+
+## 📁 Exemple d’architecture générée
+    my-app/
+    ├── src/
+    │   ├── auth/
+    │   │   ├── auth.module.ts
+    │   │   ├── controllers/
+    │   │   │   └── auth.controller.ts
+    │   │   ├── guards/
+    │   │   │   ├── auth.guard.ts
+    │   │   │   ├── jwt-auth.guard.ts
+    │   │   │   └── role.guard.ts
+    │   │   ├── services/
+    │   │   │   └── auth.service.ts
+    │   │   └── strategy/
+    │   │       └── jwt.strategy.ts
+    │   │
+    │   ├── common/
+    │   │   ├── decorators/
+    │   │   │   ├── public.decorator.ts
+    │   │   │   └── role.decorator.ts
+    │   │   ├── filters/
+    │   │   │   └── all-exceptions.filter.ts
+    │   │   ├── interceptors/
+    │   │   │   └── response.interceptor.ts
+    │   │   └── middlewares/
+    │   │       └── logger.middleware.ts
+    │   │
+    │   ├── user/
+    │   │   ├── user.module.ts
+    │   │   ├── application/
+    │   │   │   ├── dtos/
+    │   │   │   │   └── user.dto.ts
+    │   │   │   ├── interfaces/
+    │   │   │   │   └── user.repository.interface.ts
+    │   │   │   └── use-cases/
+    │   │   │       ├── create-user.use-case.ts
+    │   │   │       ├── delete-user.use-case.ts
+    │   │   │       ├── getAll-user.use-case.ts
+    │   │   │       ├── getById-user.use-case.ts
+    │   │   │       └── update-user.use-case.ts
+    │   │   │
+    │   │   ├── domain/
+    │   │   │   ├── entities/
+    │   │   │   │   └── user.entity.ts
+    │   │   │   ├── enums/
+    │   │   │   │   ├── role.enum.ts
+    │   │   │   │   └── user.enum.ts
+    │   │   │   └── mappers/
+    │   │   │       └── user.mapper.ts
+    │   │   │
+    │   │   ├── infrastructure/
+    │   │   │   ├── adapters/
+    │   │   │   │   └── user.adapter.ts
+    │   │   │   ├── repositories/
+    │   │   │   │   └── user.repository.ts
+    │   │   │   └── services/
+    │   │   │       └── user.service.ts
+    │   │   │
+    │   │   └── presentation/
+    │   │       └── controllers/
+    │   │           └── user.controller.ts
+    │   │
+    │   ├── entities/
+    │   │   └── User.entity.ts
+    │   │
+    │   ├── app.module.ts
+    │   └── main.ts
+    │
+    ├── .env
+    ├── .gitignore
+    ├── Dockerfile
+    ├── docker-compose.yml
+    ├── package.json
+    └── README.md
+
+
+---
+
+## 📌 À venir
+
+    npx nestcraft generate [nom de l'entité] → Génère un module complet automatiquement
+
+    npx nestcraft add:auth → Intègre le système d'auth JWT
+
+    Menu CLI interactif intelligent (choix d'ORM, de Bases de données (    mysql/mariaBD,firebase,mongodb...), modules, options avancées)
+
+    Génération de tests unitaires
+
+    Déploiement Docker simplifié
+
+    🧪 Intégration CI/CD de base
+
+    🌐 Site de documentation officiel
+---
+
+##❤️ Contribuer
+
+    Tu veux améliorer NestCraft ?
+    Fork le repo, ajoute tes idées, propose une Pull Request ou ouvre une issue pour en discuter !
+---
+
+## 📜 Licence
+
+    MIT © [Augustin_Selete] — libre d’usage, mais le mérite te revient 😉
+
+---

package/setup.js

@@ -0,0 +1,33 @@
+const { getUserInputs, getUserInputs2 } = require("./utils/userInput");
+const { configureDocker } = require("./utils/configs/configureDocker");
+const {
+  setupCleanArchitecture,
+} = require("./utils/configs/setupCleanArchitecture");
+const { logSuccess } = require("./utils/loggers/logSuccess");
+const { createProject } = require("./utils/setups/projectSetup");
+// const { setupPrisma } = require("./utils/setups/setupPrisma");
+const { setupAuth } = require("./utils/setups/setupAuth");
+const { setupSwagger } = require("./utils/setups/setupSwagger");
+const { setupDatabase } = require("./utils/setups/setupDatabase");
+
+async function main() {
+  const inputs = await getUserInputs2();
+
+  await createProject(inputs);
+  await setupCleanArchitecture(inputs);
+
+  if (inputs.useAuth) await setupAuth();
+  if (inputs.useSwagger) await setupSwagger(inputs.swaggerInputs);
+  if (inputs.useDocker) await configureDocker(inputs);
+
+  // await setupPrisma(inputs);
+
+  // Sélection dynamique du script de configuration BDD
+  await setupDatabase(inputs);
+  logSuccess(`Projet ${inputs.projectName} configuré avec succès!`);
+  console.log(
+    `\n🚀 Pour commencer :\n  cd ${inputs.projectName}\n  ${inputs.packageManager} run start:dev`
+  );
+}
+
+main();

package/unutils.txt

@@ -0,0 +1,173 @@
+`import { Injectable } from '@nestjs/common';
+import { ${capitalize(
+          entity
+        )}Entity } from '${entityPath}/domain/entities/${entity}.entity';
+        /* a decommenter apres migration des schema prisma */
+/* import { ${capitalize(entity)} as Prisma${capitalize(
+          entity
+        )} } from '@prisma/client'; */
+import { Create${capitalize(entity)}Dto,Update${capitalize(
+          entity
+        )}Dto } from 'src/${entity}/application/dtos/${entity}.dto';
+
+@Injectable()
+export class ${capitalize(entity)}Mapper {
+  toDomain(data: any/* Prisma${capitalize(entity)} */): ${capitalize(
+          entity
+        )}Entity {
+    return new ${capitalize(entity)}Entity(
+      data.id,
+      // ajoute ici tous les autres champs selon l'ordre de l'entité
+      // exemple:
+      // data.name,
+      // data.description,
+      // ...
+      data.createdAt,
+      data.updatedAt,
+    );
+  }
+
+  toPersistence(dto: Create${capitalize(entity)}Dto): any {
+    return {
+      // ajoute ici les champs correspondants au DTO de création
+      // exemple:
+      // name: dto.name,
+      // description: dto.description,
+      // ...
+    };
+  }
+
+  toUpdatePersistence(dto: Update${capitalize(entity)}Dto): any {
+    const data: any = {};
+    // Logique conditionnelle pour ne mettre que les champs fournis
+    // exemple:
+    // if (dto.name) data.name = dto.name;
+    // if (dto.description) data.description = dto.description;
+    return data;
+  }
+}
+`
+
+ // 📌 5. DTOs
+      const DtoFileContent = generateDto(entity);
+      await createFile({
+        path: `${entityPath}/application/dtos/${entity}.dto.ts`,
+        contente: `
+  // Importer les décorateurs nécessaires pour la validation et la documentation (Swagger)
+  // import { ApiProperty } from '@nestjs/swagger';
+  // import { IsString, IsOptional, IsInt, IsDate } from 'class-validator'; // Dépendances pour la validation
+
+  // Classe DTO pour la création de l'entité ${capitalize(entity)}
+  export class Create${capitalize(entity)}Dto {
+    // Exemple de propriété pour une chaîne de caractères
+    /* @ApiProperty({
+      description: 'Le nom complet de l\'utilisateur',
+      example: 'John Doe', // Exemple d'un nom complet
+    })
+    @IsString()
+    name: string; // Le nom de l'utilisateur, représenté par une chaîne de caractères */
+
+    // Exemple de propriété pour un nombre entier
+    /* @ApiProperty({
+      description: 'L\'âge de l\'utilisateur',
+      example: 25, // Exemple d'âge
+    })
+    @IsInt()
+    @IsOptional() // L'âge est optionnel lors de la création
+    age?: number; // Âge de l'utilisateur, un nombre entier */
+
+    // Exemple de propriété pour une date
+    /* @ApiProperty({
+      description: 'Date de naissance de l\'utilisateur',
+      example: '1996-05-20', // Exemple de date au format ISO
+    })
+    @IsDate()
+    birthdate: Date; // Date de naissance de l'utilisateur */
+  }
+
+  // Classe DTO pour la mise à jour de l'entité ${capitalize(entity)}
+  export class Update${capitalize(entity)}Dto {
+    // Exemple de propriété optionnelle pour un changement de nom
+    /* @ApiProperty({
+      description: 'Nom mis à jour de l\'utilisateur',
+      example: 'Jane Smith', // Exemple de nouveau nom
+    })
+    @IsString()
+    @IsOptional()
+    name?: string; // Nom mis à jour, chaîne de caractères optionnelle */
+
+    // Exemple de propriété optionnelle pour une mise à jour d'âge
+    /* @ApiProperty({
+      description: 'Âge mis à jour de l\'utilisateur',
+      example: 26, // Exemple d'âge mis à jour
+    })
+    @IsInt()
+    @IsOptional()
+    age?: number; // Âge mis à jour, nombre entier optionnel */
+  }
+`,
+      });
+
+
+
+
+
+`import { Injectable, NotFoundException } from '@nestjs/common';
+import { PrismaService } from 'src/prisma/prisma.service';
+import { Create${entityNameCapitalized}Dto,Update${entityNameCapitalized}Dto } from 'src/${entityNameLower}/application/dtos/${entityNameLower}.dto';
+import { I${entityNameCapitalized}Repository } from 'src/${entityNameLower}/application/interfaces/${entityNameLower}.repository.interface';
+import { ${entityNameCapitalized}Entity } from 'src/${entityNameLower}/domain/entities/${entityNameLower}.entity';
+import { ${entityNameCapitalized}Mapper } from 'src/${entityNameLower}/domain/mappers/${entityNameLower}.mapper';
+
+@Injectable()
+export class ${entityNameCapitalized}Repository implements I${entityNameCapitalized}Repository {
+  constructor(
+    private readonly prisma: PrismaService,
+    private readonly mapper: ${entityNameCapitalized}Mapper,
+  ) {}
+
+  // create
+  async create(data: Create${entityNameCapitalized}Dto): Promise<${entityNameCapitalized}Entity> {
+    const toPersist = this.mapper.toPersistence(data);
+    const created = await this.prisma.${entityNameLower}.create({ data: toPersist });
+    return this.mapper.toDomain(created);
+  }
+
+  // find by id
+  async findById(id: string): Promise<${entityNameCapitalized}Entity> {
+    const record = await this.prisma.${entityNameLower}.findUnique({
+      where: { id },
+    });
+
+    if (!record) {
+      throw new NotFoundException(\`${entityNameCapitalized}Entity with id \${id} not found\`);
+    }
+
+    return this.mapper.toDomain(record);
+  }
+
+  // update
+  async update(id: string, data: Update${entityNameCapitalized}Dto): Promise<${entityNameCapitalized}Entity> {
+    const toUpdate = this.mapper.toUpdatePersistence(data);
+    const updated = await this.prisma.${entityNameLower}.update({
+      where: { id },
+      data: toUpdate,
+    });
+
+    return this.mapper.toDomain(updated);
+  }
+
+  // find all
+  async findAll(): Promise<${entityNameCapitalized}Entity[]> {
+    const records = await this.prisma.${entityNameLower}.findMany();
+    return records.map(record => this.mapper.toDomain(record));
+  }
+
+  // delete
+  async delete(id: string): Promise<void> {
+    await this.prisma.${entityNameLower}.delete({
+      where: { id },
+    });
+  }
+}
+`

package/utils/configs/configureDocker.js

@@ -0,0 +1,16 @@
+const fs = require("fs");
+const { logInfo } = require("../loggers/logInfo");
+const { logSuccess } = require("../loggers/logSuccess");
+
+async function configureDocker(inputs) {
+  logInfo("Génération des fichiers Docker...");
+
+  const dockerfileContent = `FROM node:18\nWORKDIR /app\nCOPY . .\nRUN ${inputs.packageManager} install\nCMD ["${inputs.packageManager}", "run", "start"]`;
+  fs.writeFileSync("Dockerfile", dockerfileContent);
+
+  const dockerComposeContent = `version: '3'\nservices:\n  db:\n    image: postgres\n    restart: always\n    environment:\n      POSTGRES_USER: ${inputs.dbUser}\n      POSTGRES_PASSWORD: ${inputs.dbPassword}\n      POSTGRES_DB: ${inputs.databaseName}\n    ports:\n      - "5432:5432"`;
+  fs.writeFileSync("docker-compose.yml", dockerComposeContent);
+
+  logSuccess("Docker Configuré avec succès");
+}
+module.exports = { configureDocker };