Créer son premier projet NestJS

Créer son premier projet NestJS

Introduction

NestJS est un framework progressif pour construire des applications Node.js efficaces, fiables et scalables. Il combine les meilleures pratiques de JavaScript moderne avec la robustesse de TypeScript. Dans ce tutoriel, nous allons créer un projet NestJS de base. Assurez-vous d'avoir Node.js (version LTS) et npm ou yarn installés sur votre machine.

Prérequis

  • Node.js : Assurez-vous d'avoir la version LTS installée. Vous pouvez le vérifier avec node -v.
  • npm ou yarn : Utilisez npm -v ou yarn -v pour vérifier leur présence.

Installation du CLI NestJS

Pour commencer, nous devons installer l'outil de ligne de commande NestJS. Cela nous permettra de créer et gérer des projets facilement.

npm install -g @nestjs/cli

Création du projet

Créez un nouveau projet en exécutant la commande suivante :

nest new mon-projet

Vous serez invité à choisir un gestionnaire de paquets (npm ou yarn). Choisissez celui avec lequel vous êtes le plus à l'aise.

Structure des dossiers générée

Une fois le projet créé, vous obtiendrez une structure de dossiers similaire à ceci :


mon-projet/
├── src/
│   ├── app.controller.ts
│   ├── app.module.ts
│   └── app.service.ts
├── test/
├── node_modules/
├── package.json
└── tsconfig.json

Explication de chaque fichier

  • main.ts : Le point d'entrée de l'application. Il initialise l'application NestJS.
  • app.module.ts : Le module principal de l'application. Il regroupe les contrôleurs et les services.
  • app.controller.ts : Gère les requêtes HTTP entrantes et renvoie les réponses appropriées.
  • app.service.ts : Contient la logique métier et est injecté dans le contrôleur.

Lancer le serveur de développement

Pour démarrer le serveur de développement, utilisez la commande suivante :

npm run start:dev

Le serveur sera accessible à http://localhost:3000. Vous devriez voir le message par défaut : "Hello World!".

Tester le endpoint par défaut

Ouvrez votre navigateur et accédez à http://localhost:3000 pour vérifier que votre application fonctionne correctement.

Scripts npm disponibles

Dans le fichier package.json, vous trouverez plusieurs scripts utiles :

  • start : Démarre l'application en mode production.
  • start:dev : Démarre l'application en mode développement avec rechargement à chaud.
  • test : Exécute les tests unitaires.
  • build : Compile l'application en JavaScript.

Conclusion

Félicitations ! Vous avez créé votre premier projet NestJS et exploré sa structure de base. Vous pouvez maintenant étendre votre application en ajoutant plus de modules, contrôleurs et services pour répondre à vos besoins. Pour approfondir vos connaissances, consultez la documentation officielle de NestJS.

Commentaires

Soyez le premier à laisser un commentaire !

Laisser un commentaire

Les champs obligatoires sont indiqués avec *