stay booker hotel booking express api

Estadía booker hotel booking express api

Bienvenido al Repositorio de API de STATE Booker Hotel Booking Express. Esta API sirve como la columna vertebral para la reserva del hotel Stay Booker React Frontend, proporcionando una solución sólida de backend para administrar reservas de hoteles, cuentas de usuarios y más. Construido con Express.js e integrado con MySQL a través de SECLELIZE, este proyecto está diseñado para ofrecer una plataforma perfecta y eficiente para aplicaciones de reservas de hoteles.

Empezando

Requisitos previos

• Node.js (V16 o más tarde recomendado)
• Mysql
• Git
• Postman (para probar puntos finales de API)

Configuración del medio ambiente

1. Clonar el repositorio

git clone https://github.com/iZooGooD/stay-booker-hotel-booking-express-api.git
cd stay-booker-hotel-booking-express-api

2. Instalar dependencias

npm install

3. Configurar mysql

Asegúrese de que MySQL esté instalado en su Windows/Linux/Mac. Cree dos bases de datos: una para producción y otra para pruebas.

 CREATE DATABASE staybooker_prod ;
CREATE DATABASE staybooker_test ;

4. Configurar variables de entorno

Copie el archivo .env.example a un nuevo archivo llamado .env y actualice con su configuración de base de datos MySQL y otras configuraciones.

 # 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

Ejecutando la aplicación

Al iniciar la aplicación, Sequelize creará automáticamente las tablas necesarias en la base de datos especificada.

npm run start:dev

Prueba de puntos finales de API con Postman

Para garantizar las funciones API como se esperaba, recomendamos usar Postman para probar los puntos finales. Importe la colección Postman proporcionada (si está disponible) para comenzar rápidamente a probar la funcionalidad de la API, incluida la autenticación del usuario, las listas de hoteles, las reservas y más.

SECUSION y MYSQL

Este proyecto utiliza Sequelize, un Node.js ORM basado en promesa, para la gestión de la base de datos. SECLELIZE simplifica las interacciones MySQL, lo que permite una fácil manipulación de datos y consultas a través de modelos que representan tablas de bases de datos. La configuración para la secuela se encuentra en config/config.js , y los modelos se encuentran en el directorio models .

Que contribuye

¡Agradecemos las contribuciones a la API STATE Booker Hotel Booking Express! Ya sea que agregue nuevas funciones, arreglando errores o mejorando la documentación, se agradece su ayuda. Lea nuestras pautas de contribución (para ser creadas) para obtener más información sobre cómo contribuir de manera efectiva.

Calidad del código

La calidad del código importa mucho en este proyecto. Nos esforzamos por mantener altos estándares de calidad y legibilidad del código. Asegúrese de que sus contribuciones se adhieran a estos estándares y sean bien probados.

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.