stay booker hotel booking express api

Оставайся букеров

Добро пожаловать в The Stay Booker Hotel Brineing Express API Repository. Этот API служит основой для бронирования отеля Booker Booker React Frontend, предоставляя надежное бэкэндное решение для управления бронированием отелей, учетными записями пользователей и многим другим. Этот проект, построенный с Express.js и интегрированным с MySQL посредством Scentize, предназначен для обеспечения беспроблемной и эффективной платформы для приложений для бронирования отелей.

Начиная

Предварительные условия

• 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

Убедитесь, что 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

Запуск приложения

После запуска приложения Scielize автоматически создаст необходимые таблицы в указанной базе данных.

npm run start:dev

Тестирование конечных точек API с почтальником

Чтобы обеспечить функции API, как и ожидалось, мы рекомендуем использовать Postman для тестирования конечных точек. Импортируйте предоставленную коллекцию Postman (если доступно), чтобы быстро начать тестирование функциональности API, включая аутентификацию пользователей, списки отелей, бронирование и многое другое.

Продолжение и MySQL

В этом проекте используется продолжение, основанное на обещаниях node.js orm, для управления базами данных. Scentize упрощает взаимодействие MySQL, позволяя легко манипулировать данными и запросить модели, которые представляют таблицы базы данных. Конфигурация для продолжения продолжения находится в config/config.js , а модели расположены в каталоге models .

Внося

Мы приветствуем вклад в Booker Hotel Hotel Brineing Express API! Будь то добавление новых функций, исправление ошибок или улучшение документации, ваша помощь ценится. Пожалуйста, прочитайте наши рекомендации (для создания) для получения дополнительной информации о том, как эффективно внести свой вклад.

Качество кода

Качество кода очень важно в этом проекте. Мы стремимся поддерживать высокие стандарты качества и читаемости кода. Пожалуйста, убедитесь, что ваши взносы придерживаются этих стандартов и хорошо проверены.

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.