stay booker hotel booking express api

Stay Booker Hotel Booking Express API

Stay Booker Hotel Booking Express API 저장소에 오신 것을 환영합니다. 이 API는 Stay Booker Hotel Booking 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을 설정하십시오

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

응용 프로그램 실행

애플리케이션을 시작하면 속편은 지정된 데이터베이스에서 필요한 테이블을 자동으로 작성합니다.

npm run start:dev

우체부로 API 엔드 포인트를 테스트합니다

API 기능이 예상대로 작동하도록하려면 엔드 포인트 테스트를 위해 Postman을 사용하는 것이 좋습니다. 제공된 Postman 컬렉션 (사용 가능한 경우)을 가져와 사용자 인증, 호텔 목록, 예약 등을 포함하여 API 기능을 신속하게 테스트하십시오.

속도와 MySQL

이 프로젝트는 데이터베이스 관리를 위해 Promise-Based Node.js ORM 인 Sequelize를 사용합니다. 속도는 MySQL 상호 작용을 단순화하여 데이터베이스 테이블을 나타내는 모델을 통해 쉽게 데이터 조작 및 쿼리를 허용합니다. 속편의 구성은 config/config.js 에 있으며 모델은 models 디렉토리에 있습니다.

기여

우리는 Stay Booker Hotel Booking Express API에 대한 기여를 환영합니다! 새로운 기능을 추가하거나 버그 수정 또는 문서 개선에 관계없이 도움을 주시면 도움이됩니다. 효과적으로 기여하는 방법에 대한 자세한 내용은 기고 가이드 라인 (작성)을 읽으십시오.

코드 품질

이 프로젝트에서는 코드 품질이 중요합니다. 우리는 높은 표준의 코드 품질과 가독성을 유지하기 위해 노력합니다. 귀하의 기여가 이러한 표준을 준수하고 잘 테스트를 받도록하십시오.

특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 라이센스 파일을 참조하십시오.