stay booker hotel booking express api

停留的布克酒店預訂快遞API

歡迎來到Booker Hotel預訂Express API存儲庫。該API是住宿Booker Hotel預訂React Frontend的骨幹，為管理酒店預訂，用戶帳戶等提供了強大的後端解決方案。該項目由Express.js建造，並通過續集與MySQL集成，旨在為酒店預訂應用提供一個無縫，高效的平台。

入門

先決條件

• node.js（v16或以後推薦）
• mysql
• git
• 郵遞員（用於測試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

確保在Windows/Linux/Mac上安裝MySQL。創建兩個數據庫：一個用於生產，一個用於測試。

 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

運行應用程序

啟動應用程序後，續集將在指定數據庫中自動創建必要的表。

npm run start:dev

使用Postman測試API端點

為了確保API按預期運行，我們建議使用Postman測試端點。導入提供的Postman集合（如果有），以快速開始測試API的功能，包括用戶身份驗證，酒店列表，預訂等。

續集和mysql

該項目將基於承諾的node.js orm semelize用於數據庫管理。續集簡化了MySQL的交互，從而可以輕鬆地通過代表數據庫表的模型進行查詢。續集的配置在config/config.js中找到，模型位於models目錄中。

貢獻

我們歡迎對Booker Hotel預訂Express API的貢獻！無論是添加新功能，修復錯誤還是改進文檔，您的幫助都將受到讚賞。請閱讀我們的貢獻指南（要創建），以獲取有關如何有效貢獻的更多信息。

代碼質量

代碼質量在此項目中非常重要。我們努力保持高標準的代碼質量和可讀性。請確保您遵守這些標準並經過良好的測試。

執照

該項目是根據MIT許可證獲得許可的 - 有關詳細信息，請參見許可證文件。