Projet n°7 OpenClassrooms Développeur Web. — 24 août 2022.

Introduction

Cette partie est spécialement pour le backend du projet. Il est sous ExpressJS côté serveur, et sous MariaDB côté base de données. Pour le choix de l'ORM, Prisma a été choisi.

Note

Si vous souhaitez voir la page frontend, veuillez vous rendre sur ce dépôt GitHub.

Installation

Pour pouvoir exécuter ce projet, veuillez suivre ces étapes.

1. Installez NodeJS (>= 16.10) et npm.
2. Installez les dépendances nécessaires.
3. Copiez le fichier .env.example en .env et remplacez les valeurs par vos propres.
4. N'oubliez pas d'avoir un accès à votre base de données MariaDB
5. Exécutez le script backend, à coup de npm run serve. Port 3000
6. Vous pouvez maintenant accéder à l'API.
7. Pour la tester, allez sur localhost:3000/status devrait vous renvoyer un message de succès.

Configuration du .env

Exemple de .env :

FRONTEND_URL=http://localhost:5000
DATABASE_URL=mysql://USER:MDP@IP:3306/BDD

Note > FRONTEND_URL est le domaine de votre site, ici utilisé pour des raisons de sécurité (cors), nous délimitons les calls API que depuis ce domaine.

Prisma

Génération des fichiers Prisma :

npx prisma generate

Pour la gestion de la base de données, nous utilisons Prisma. Pour plus d'informations, veuillez vous rendre sur la documentation de Prisma.

Synchronisez le modèle de données src/db/schema.prisma avec la base de données :

npx prisma db push

Initialisation de la base de données avec des valeurs par défaut :

Pour avoir le compte Admin

npx prisma db seed

Email : admin@ndd.local Mot de passe : password

Développement

• Projet réalisé avec IntelliJ.
• Testé avec Insomnia
• Documentation format OpenAI

Contributions

Les contributions sont toujours les bienvenues ! Lisez les règles pour les contributions avant de pouvoir y participer.

Veuillez vous assurer que votre demande de pull request respecte les lignes directrices suivantes :

• Rechercher des suggestions précédentes avant d'en faire une nouvelle, afin d'éviter les doublons.
• Les fichiers README suggérés devraient être beau ou se démarquer d'une manière ou d'une autre.
• Faire une demande de pull request individuelle pour chaque suggestion.
• De nouvelles catégories ou des améliorations à la catégorisation existante sont les bienvenues.
• Gardez les descriptions courtes et simples, mais descriptives.
• Commencez la description avec une capitale et terminez par un arrêt/période complet.
• Vérifiez votre orthographe et votre grammaire.
• Assurez-vous que votre éditeur de texte est configuré pour supprimer les espaces de fin.

Merci pour vos suggestions !