stay booker hotel booking express api

Booker Hotel Booking Express API

ยินดีต้อนรับสู่ที่เก็บข้อมูลการจองโรงแรม Booker Booker Express API นี้ทำหน้าที่เป็นกระดูกสันหลังสำหรับการจองโรงแรม Booker Booking React Frontend ซึ่งเป็นโซลูชั่นแบ็กเอนด์ที่แข็งแกร่งสำหรับการจัดการการจองโรงแรมบัญชีผู้ใช้และอื่น ๆ สร้างขึ้นด้วย Express.js และรวมเข้ากับ MySQL ผ่าน Sequelize โครงการนี้ได้รับการออกแบบมาเพื่อนำเสนอแพลตฟอร์มที่ราบรื่นและมีประสิทธิภาพสำหรับแอปพลิเคชันการจองโรงแรม

เริ่มต้น

ข้อกำหนดเบื้องต้น

• node.js (แนะนำ V16 หรือใหม่กว่า)
• mysql
• กระตวน
• บุรุษไปรษณีย์ (สำหรับการทดสอบจุดสิ้นสุด API)

การตั้งค่าสภาพแวดล้อม

1. โคลนที่เก็บ

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

2. ติดตั้งการพึ่งพา

npm install

3. ตั้งค่า mysql

ตรวจสอบให้แน่ใจว่า MySQL ติดตั้งบน Windows/Linux/Mac ของคุณ สร้างฐานข้อมูลสองฐาน: หนึ่งสำหรับการผลิตและอีกอันสำหรับการทดสอบ

 CREATE DATABASE staybooker_prod ;
CREATE DATABASE staybooker_test ;

4. กำหนดค่าตัวแปรสภาพแวดล้อม

คัดลอกไฟล์ .env.example ไปยังไฟล์ใหม่ชื่อ .env และอัปเดตด้วยการตั้งค่าฐานข้อมูล MySQL ของคุณและการกำหนดค่าอื่น ๆ

 # 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

การรันแอปพลิเคชัน

เมื่อเริ่มต้นแอปพลิเคชัน Sequelize จะสร้างตารางที่จำเป็นในฐานข้อมูลที่ระบุโดยอัตโนมัติ

npm run start:dev

การทดสอบจุดสิ้นสุด API กับบุรุษไปรษณีย์

เพื่อให้แน่ใจว่าฟังก์ชั่น API ตามที่คาดไว้เราขอแนะนำให้ใช้ Postman สำหรับการทดสอบจุดสิ้นสุด นำเข้าคอลเลกชันบุรุษไปรษณีย์ที่ให้มา (ถ้ามี) เพื่อเริ่มทดสอบฟังก์ชั่นของ API อย่างรวดเร็วรวมถึงการตรวจสอบสิทธิ์ผู้ใช้รายชื่อโรงแรมการจองและอื่น ๆ

Sequelize และ MySQL

โครงการนี้ใช้ Sequelize, Node.js ORM ตามสัญญาสำหรับการจัดการฐานข้อมูล Sequelize ทำให้การโต้ตอบ MySQL ง่ายขึ้นช่วยให้สามารถจัดการข้อมูลได้ง่ายและสอบถามผ่านโมเดลที่แสดงถึงตารางฐานข้อมูล การกำหนดค่าสำหรับภาคต่อพบใน config/config.js และรุ่นอยู่ในไดเรกทอรี models

การบริจาค

เรายินดีต้อนรับการมีส่วนร่วมในการเข้าพักโรงแรม Booker Booking Express API! ไม่ว่าจะเป็นการเพิ่มคุณสมบัติใหม่การแก้ไขข้อบกพร่องหรือการปรับปรุงเอกสารความช่วยเหลือของคุณได้รับการชื่นชม โปรดอ่านแนวทางการสนับสนุนของเรา (เพื่อสร้าง) สำหรับข้อมูลเพิ่มเติมเกี่ยวกับวิธีการมีส่วนร่วมอย่างมีประสิทธิภาพ

คุณภาพรหัส

คุณภาพรหัสมีความสำคัญมากในโครงการนี้ เรามุ่งมั่นที่จะรักษามาตรฐานคุณภาพและความสามารถในการอ่านรหัสสูง โปรดตรวจสอบให้แน่ใจว่าการมีส่วนร่วมของคุณเป็นไปตามมาตรฐานเหล่านี้และได้รับการทดสอบอย่างดี

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT - ดูไฟล์ใบอนุญาตสำหรับรายละเอียด