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许可证获得许可的 - 有关详细信息，请参见许可证文件。