stay booker hotel booking express api

Séjour booker hôtel réservation express API

Bienvenue dans le référentiel API Booker Booking Express Stay Booker. Cette API sert de dynamique pour le Frontend React Frontend React, offrant une solution backend robuste pour gérer les réservations d'hôtels, les comptes d'utilisateurs, etc. Construit avec Express.js et intégré à MySQL via Sequelize, ce projet est conçu pour offrir une plate-forme efficace et efficace pour les applications de réservation d'hôtels.

Commencer

Condition préalable

• Node.js (v16 ou ultérieure recommandé)
• Mysql
• Git
• Postman (pour tester les points de terminaison de l'API)

Configuration de l'environnement

1. Cloner le référentiel

git clone https://github.com/iZooGooD/stay-booker-hotel-booking-express-api.git
cd stay-booker-hotel-booking-express-api

2. Installer des dépendances

npm install

3. Configurer MySQL

Assurez-vous que MySQL est installé sur votre Windows / Linux / Mac. Créez deux bases de données: une pour la production et une pour les tests.

 CREATE DATABASE staybooker_prod ;
CREATE DATABASE staybooker_test ;

4. Configurer les variables d'environnement

Copiez le fichier .env.example dans un nouveau fichier nommé .env et mettez-le à jour avec vos paramètres de base de données MySQL et autres configurations.

 # Development Environment
DEV_DB_HOST=localhost
DEV_DB_USER=yourusername
DEV_DB_PASS=yourpassword
DEV_DB_NAME=staybooker_test

# Production Environment
PROD_DB_HOST=localhost
PROD_DB_USER=yourusername
PROD_DB_PASS=yourpassword
PROD_DB_NAME=staybooker_prod

# JWT Secret
JWT_SECRET=jwtsecretforproject

Exécution de l'application

Lors du démarrage de l'application, Sequelize créera automatiquement les tables nécessaires dans la base de données spécifiée.

npm run start:dev

Tester les points de terminaison de l'API avec Postman

Pour garantir les fonctions de l'API comme prévu, nous vous recommandons d'utiliser Postman pour tester les points de terminaison. Importez la collection Postman fournie (si disponible) pour commencer rapidement à tester les fonctionnalités de l'API, y compris l'authentification des utilisateurs, les listes d'hôtels, les réservations, etc.

Séquestre et mysql

Ce projet utilise Sequelize, un Node.js Orm basé sur les promesses, pour la gestion des bases de données. Sequelize simplifie les interactions MySQL, permettant une manipulation facile des données et une interrogation via des modèles qui représentent des tables de base de données. La configuration de séquelle se trouve dans config/config.js , et les modèles se trouvent dans le répertoire models .

Contributif

Nous accueillons des contributions à l'API Express Booker Booking Express Stay Booker! Qu'il s'agisse d'ajouter de nouvelles fonctionnalités, de corriger les bogues ou d'améliorer la documentation, votre aide est appréciée. Veuillez lire nos directives contributives (à créer) pour plus d'informations sur la façon de contribuer efficacement.

Qualité du code

La qualité du code compte beaucoup dans ce projet. Nous nous efforçons de maintenir des normes élevées de qualité et de lisibilité du code. Veuillez vous assurer que vos contributions respectent ces normes et sont bien testées.

Licence

Ce projet est autorisé en vertu de la licence MIT - voir le fichier de licence pour plus de détails.