Bienvenue dans l'API Back-End de la bibliothèque de thé! Cette API permet aux utilisateurs de se connecter, de créer des thés qui s'ajoutent à une liste, et d'interagir avec la bibliothèque de diverses manières. Elle est construite avec NestJS, un framework Node.js puissant et évolutif, utilisant TypeScript pour une meilleure expérience de développement.
- Authentification et gestion des utilisateurs.
- Création, mise à jour et suppression de thés dans la bibliothèque.
- Gestion des amis et des interactions sociales.
- Prise en charge des tests unitaires et de bout en bout.
- Support pour le développement, le mode veille et le mode production.
Suivez ces étapes pour installer le projet et ses dépendances :
-
Clonez ce dépôt GitHub : ```bash git clone https://github.com/LucasGascn/teaPoteBack.git cd teaPoteBack ```
-
Installez les dépendances : ```bash npm i ```
Voici quelques commandes utiles pour travailler avec l'API :
-
Démarrer l'application :
- Développement :
npm run start - Mode veille :
npm run start:dev - Production :
npm run start:prod
- Développement :
-
Tester l'application :
- Tests unitaires :
npm run test - Tests de bout en bout :
npm run test:e2e - Couverture des tests :
npm run test:cov
- Tests unitaires :
-
Prisma :
- Générer les migrations :
npx prisma migrate dev - Appliquer les migrations :
npx prisma migrate deploy - Ouvrir le studio Prisma :
npx prisma studio
- Générer les migrations :
-
Autres Commandes NestJS :
- Générer un module :
nest g module <nom> - Générer un contrôleur :
nest g controller <nom> - Générer un service :
nest g service <nom>
- Générer un module :
Si vous souhaitez contribuer au projet, nous serions ravis de recevoir vos suggestions et contributions. Veuillez consulter les règles de contribution pour plus d'informations.
Pour des questions ou des problèmes, vous pouvez rejoindre notre serveur Discord ou contacter le développeur principal.
Ce projet est sous licence MIT.