stay booker hotel booking express api

Stay Booker Hotel Booking Express API

Willkommen zum Aufenthalt von Booker Hotel Booking Express API -Repository. Diese API dient als Rückgrat für die Aufenthalt von Booker Hotel Booking React Frontend und bietet eine robuste Backend -Lösung für die Verwaltung von Hotelbuchungen, Benutzerkonten und vielem mehr. Dieses Projekt wurde mit Express.js erstellt und in MySQL integriert. Dieses Projekt bietet eine nahtlose und effiziente Plattform für Hotelbuchungsanwendungen.

Erste Schritte

Voraussetzungen

• Node.js (v16 oder später empfohlen)
• Mysql
• Git
• Postman (zum Testen von API -Endpunkten)

Umgebungsaufbau

1. Klonen Sie das Repository

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

2. Abhängigkeiten installieren

npm install

3. Richten Sie MySQL ein

Stellen Sie sicher, dass MySQL unter Windows/Linux/Mac installiert ist. Erstellen Sie zwei Datenbanken: eine für die Produktion und eine zum Testen.

 CREATE DATABASE staybooker_prod ;
CREATE DATABASE staybooker_test ;

4. Konfigurieren von Umgebungsvariablen

Kopieren Sie die Datei .env.example in eine neue Datei mit dem Namen .env und aktualisieren Sie sie mit Ihren MySQL -Datenbankeinstellungen und anderen Konfigurationen.

 # 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

Ausführen der Anwendung

Nach Beginn der Anwendung erstellt das Folgenbereich automatisch die erforderlichen Tabellen in der angegebenen Datenbank.

npm run start:dev

Testen von API -Endpunkten mit Postboten

Um sicherzustellen, dass die API wie erwartet funktioniert, empfehlen wir, den Postanwalt zum Testen der Endpunkte zu verwenden. Importieren Sie die bereitgestellte Postman -Sammlung (falls verfügbar), um schnell die Funktionalität der API zu testen, einschließlich Benutzerauthentifizierung, Hotellisten, Buchungen und vielem mehr.

Folgen und MySQL

In diesem Projekt wird das Folgende, ein versprochener Node.js ORM, für die Datenbankverwaltung verwendet. Folgen Sie die MySQL -Interaktionen und ermöglichen eine einfache Datenmanipulation und Abfragen durch Modelle, die Datenbanktabellen darstellen. Die Konfiguration für die Folge findet sich in config/config.js und Modelle befinden sich im models .

Beitragen

Wir begrüßen Beiträge zur Aufenthalt -Booker Hotel Booking Express API! Unabhängig davon, ob neue Funktionen hinzugefügt, Fehler behoben werden oder die Dokumentation verbessert werden, Ihre Hilfe wird geschätzt. Bitte lesen Sie unsere beitragenden Richtlinien (zu erstellen), um weitere Informationen zum effektiven Beitrag zu erhalten.

Codequalität

Codequalität ist in diesem Projekt sehr wichtig. Wir bemühen uns, hohe Standards für Codequalität und Lesbarkeit aufrechtzuerhalten. Bitte stellen Sie sicher, dass Ihre Beiträge diese Standards entsprechen und gut getestet sind.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.