stay booker hotel booking express api

Stay Booker Hotel Booking Express API

Stay Booker Hotel Booking Express APIリポジトリへようこそ。このAPIは、Stay Booker Hotelの予約React Frontendのバックボーンとして機能し、ホテルの予約、ユーザーアカウントなどを管理するための堅牢なバックエンドソリューションを提供します。 Express.jsで構築され、MySQLと統合されてSequelizeを介して、このプロジェクトは、ホテル予約アプリケーション用のシームレスで効率的なプラットフォームを提供するように設計されています。

はじめる

前提条件

• node.js（V16以降の推奨）
• mysql
• git
• Postman（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にインストールされていることを確認してください。 2つのデータベースを作成します。1つは生産用、もう1つはテスト用です。

 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

アプリケーションの実行

アプリケーションを開始すると、Secelizeは指定されたデータベースに必要なテーブルを自動的に作成します。

npm run start:dev

PostmanでAPIエンドポイントをテストします

APIが予想どおりに機能するようにするには、エンドポイントをテストするためにPostmanを使用することをお勧めします。提供されたPostmanコレクション（利用可能な場合）をインポートして、ユーザー認証、ホテルのリスト、予約など、APIの機能のテストを迅速に開始します。

後遺症とmysql

このプロジェクトでは、データベース管理には約束ベースのnode.js ormであるSequelizeが使用されます。 SequelizeはMySQLの相互作用を簡素化し、データ操作が簡単になり、データベーステーブルを表すモデルを介したクエリを可能にします。 Sequelizeの構成はconfig/config.jsにあり、モデルはmodelsディレクトリにあります。

貢献

Stay Booker Hotel Booking Express APIへの貢献を歓迎します！新しい機能を追加する、バグの修正、ドキュメントの改善など、ヘルプが高く評価されています。効果的に貢献する方法の詳細については、貢献ガイドライン（作成する）をお読みください。

コード品質

このプロジェクトでは、コードの品質が非常に重要です。私たちは、コードの品質と読みやすさの高い標準を維持するよう努めています。あなたの貢献がこれらの基準に準拠し、十分にテストされていることを確認してください。

ライセンス

このプロジェクトは、MITライセンスに基づいてライセンスされています。詳細については、ライセンスファイルを参照してください。