@neosyn-ee/boilerplate-common

NestJS Library Boilerplate

Questo repository contiene un boilerplate per creare librerie riutilizzabili utilizzando il framework NestJS. È progettato per agevolare lo sviluppo di moduli condivisi e funzionalità modulari per applicazioni NestJS.

Struttura del Progetto

La repository utilizza la struttura monorepo di NestJS, che permette di gestire e sviluppare librerie all'interno di un unico progetto.

• libs/common: Esempio di una libreria NestJS generata con il comando nest g library common. Può includere utilità condivise, DTO, validatori, costanti e altro.

• apps: Può contenere applicazioni che utilizzano le librerie sviluppate in questa repository.

nestjs-library-boilerplate/
├── apps/
│   └── your-app/ # Applicazioni NestJS che consumano le librerie
├── libs/
│   ├── common/  # Libreria di esempio generata con NestJS
    └── type/ # Aggiungi i tipi
│   └── your-library/ # Aggiungi altre librerie qui
└── README.md

Requisiti

• Node.js versione >= 18.x
• NestJS CLI versione >= 9.x

Installazione

1. Fai il fork del repository:

   • Vai al repository su GitHub e fai clic su "Fork" per creare una tua copia del progetto.

2. Clona il repository forkato:

   git clone https://github.com/tuo-utente/nome-repository.git
   cd nome-repository

Creare una Nuova Libreria

Puoi creare una nuova libreria utilizzando il comando CLI di NestJS:

nest g library nome-libreria

Ad esempio:

nest g library utils

La libreria sarà creata in libs/utils e sarà automaticamente configurata nel progetto.

Utilizzo delle Librerie

Per utilizzare una libreria in un'applicazione NestJS, importa il modulo corrispondente nel file del modulo principale (o in altri moduli):

import { Module } from '@nestjs/common';
import { CommonModule } from '@nestjs/common';

@Module({
  imports: [CommonModule],
})
export class AppModule {}

Licenza

Questo progetto è rilasciato sotto licenza MIT.