GitHub - Clic-stack/Booking-App: Booking-App is a backend REST API built with Node.js, Express, and Sequelize. It manages hotels and cities, users, bookings, reviews, and images, featuring JWT authentication and Cloudinary integration for secure and scalable reservation handling.

🏨 Booking App

Tip

Quick Setup Note: This project includes default values (fallbacks) for the JWT_SECRET in development and testing environments. This facilitates rapid deployment and ensures the test suite runs out-of-the-box without extra security overhead.

A backend system built with Express, Sequelize, and PostgreSQL to manage hotel reservations. This project provides a complete API for handling users, cities, hotels, images, bookings, and reviews, ensuring a secure, scalable, and user-friendly architecture.

🌐 Deployment

🚀 Backend: Server online with Render

🔗 https://booking-app-b5o8.onrender.com

📄 BookingApp: Documentation online with Postman

🔗 https://documenter.getpostman.com/view/48309056/2sBXVZnDx7

🌐 GitHub Repository

🔗 https://github.com/Clic-stack/Booking-App

🟢 Technical Quality Assurance (QA) & Automation

What does the "passing" badge at the beginning of this project mean? In a professional environment, it is not enough for an application to simply "work"; it must be reliable. This project implements Real-World Integration Tests. This means that every time a code change is made, an automated surveillance system that ensures every component (Database, Security, and Functions) operates correctly, even when handling high volumes of information.

Green Badge (Passing): Indicates the code is solid and secure. It has passed all quality inspections and is ready for use in a real-world production environment without unexpected errors.
Red Badge (Failing): Acts as an emergency brake. If a technical error is detected, the system automatically blocks any updates before they can affect the end user or compromise data integrity.

In summary: This badge is your guarantee that the software has been built under professional standards, prioritizing stability and data protection at all times.

📊 Database Architecture

erDiagram
    USER ||--o{ BOOKING : "makes"
    USER ||--o{ REVIEW : "writes"
    HOTEL ||--o{ BOOKING : "receives"
    HOTEL ||--o{ REVIEW : "has"
    HOTEL ||--o{ IMAGE : "displays"
    CITY ||--o{ HOTEL : "contains"

    USER {
        string firstName
        string lastName
        string email
        string password
    }
    HOTEL {
        string name
        text description
        float price
        float averageRating
    }
    BOOKING {
        date checkIn
        date checkOut
    }
    REVIEW {
        int rating
        text comment
    }

🎯 Project Goals

This project was designed to:

Implement CRUD endpoints for Users, Cities, Hotels, Images, Bookings, and Reviews.
Provide authentication and authorization using JWT.
Enable hotel filtering by city and name, with average ratings calculated from reviews.
Support reservations linked to logged-in users and enforce update restrictions.
Deliver professional documentation and reproducible workflows for collaborative development.

🚀 Key Features & Implementation Details

✅ Full API Coverage (25 Endpoints): 100% of required endpoints implemented, including private and public routes, ensuring a complete management system for Users, Cities, Hotels, Images, Bookings, and Reviews.
🧪 Professional Testing Suite: Robust implementation of Jest and Supertest, with automated tests for every endpoint to guarantee reliability and prevent regressions in the business logic.
🔐 Advanced Authentication & Security:
- User login system with JWT (JSON Web Tokens).
- Protected routes requiring valid tokens for sensitive operations (Bookings, Reviews, User management).
- Password hashing using bcrypt and security headers with Helmet.
📂 Multimedia Management: Integrated Cloudinary for professional image hosting and management, handled via Multer for seamless file uploads.
📊 Smart Data Processing:
- Dynamic Rating Calculation: Automatically generates an average field for hotels by aggregating scores from all related reviews.
- Advanced Querying: Smart search for hotels by name and cityId.
- Optimized Pagination: Implemented offset and perPage logic for reviews to ensure high performance and scalability.
🛠️ Clean Architecture & Reliable Workflows:
- Centralized Error Handling for predictable API responses.
- Relational Database Modeling with Sequelize and PostgreSQL, ensuring data integrity and strictly enforcing update restrictions (e.g., preventing modification of userId in bookings).

📊 Project Architecture Summary

Backend: Node.js & Express.
Database: PostgreSQL with Sequelize ORM.
Storage: Cloudinary API.
Documentation: Postman (Online).
Deployment: Render.

🧪 Testing Suite

Quality assurance is a priority in this project. A comprehensive test suite was developed using Jest and Supertest to validate every layer of the API.

Total Coverage: 22/25 mandatory endpoints tested (100% Core Business Logic).
CI/CD Pipeline: ✅ Automated Real-World Integration Tests powered by GitHub Actions, validating live connections with PostgreSQL. Every push or pull request triggers the full test suite to guarantee stability in both production and development environments.
Scope:
- Integration Tests: Ensuring seamless interaction between routes, controllers, and the PostgreSQL database for Users, Cities, Hotels, Bookings, and Reviews.
- Security Tests: Verifying JWT authorization and restricted access to private routes.
  
  Note: Image upload endpoints are verified through manual functional testing via Postman to optimize CI/CD performance and third-party storage usage.

To run the tests locally:

npm test

💻 Tech Stack

Backend Tools	Database	Security & Middleware	Utilities
Node.js	PostgreSQL	Helmet	bcrypt
Express	Sequelize	CORS	uuid
Morgan	pg/pg-hstore	JWT	multer
Cloudinary			streamifier

🧪 API Coverage

The following endpoints are implemented:

Users

GET /users – Retrieve all users (private) ✅
POST /users – Create a new user (public) ✅
DELETE /users/:id – Delete a user by ID (private) ✅
PUT /users/:id – Update a user by ID (private) ✅
POST /users/login – User login (public) ✅

Cities

GET /cities – Retrieve all cities (public) ✅
POST /cities – Create a new city (private) ✅
DELETE /cities/:id – Delete a city by ID (private) ✅
PUT /cities/:id – Update a city by ID (private) ✅

Hotels

GET /hotels – Retrieve all hotels (public) ✅
Supports queries: name, cityId Example: /hotels?name=Four%20Seasons&cityId=1
Includes field average with average rating from reviews.
GET /hotels/:id – Retrieve hotel by ID (public) ✅
POST /hotels – Create a new hotel (private) ✅
DELETE /hotels/:id – Delete a hotel by ID (private) ✅
PUT /hotels/:id – Update a hotel by ID (private) ✅

Images

GET /images – Retrieve all images (private) ✅*
POST /images – Upload a new image (private) ✅*
DELETE /images/:id – Delete an image by ID (private) ✅*

*Validated through manual functional testing (Postman)

Bookings

GET /bookings – Retrieve bookings of logged-in user (private) ✅
POST /bookings – Create a booking (private, userId = logged-in user) ✅
DELETE /bookings/:id – Delete a booking (private) ✅
PUT /bookings/:id – Update booking dates (private, only checkIn and checkOut) ✅

Reviews

GET /reviews – Retrieve all reviews (public) ✅
Supports queries: hotelId, offset, perPage for pagination.
Example: /reviews?hotelId=1&offset=0&perPage=10
POST /reviews – Create a review (private, userId = logged-in user) ✅
DELETE /reviews/:id – Delete a review (private) ✅
PUT /reviews/:id – Update review rating/comment (private, userId and hotelId cannot be updated) ✅

📄 Scripts (package.json)

"scripts": {
  "dev": "node --watch --env-file=.env src/server.js",
  "start": "node src/server.js",
  "test": "node --env-file=.env node_modules/jest/bin/jest.js"
}

🗂️ Project Structure

📁 BOOKING-APP
|   ├── 📁 node_modules/
|   ├── 📁 src/
│   |   └── 📁 config/
│   |   |    └── env.js
│   |   |    └── cloudinary.js
│   |   └── 📁 controllers/
│   |   |    └── booking.controller.js
│   |   |    └── city.controller.js
│   |   |    └── hotel.controller.js
│   |   |    └── image.controller.js
│   |   |    └── review.controller.js
│   |   |    └── user.controller.js
│   |   └── 📁 db/
│   |   |    └── connect.js
│   |   └── 📁 lib/
│   |   |    └── utils.js
│   |   └── 📁 middlewares/
│   |   |    └── auth.js
│   |   |    └── catchError.js
│   |   |    └── errorHandler.js
│   |   |    └── upload.js
│   |   └── 📁 models/
│   |   |    └── booking.model.js
│   |   |    └── city.model.js
│   |   |    └── hotel.model.js
│   |   |    └── Image.model.js
│   |   |    └── review.model.js
│   |   |    └── user.model.js
│   |   └── 📁 routes/
│   |   |    └── booking.route.js
│   |   |    └── city.route.js
│   |   |    └── hotel.route.js
│   |   |    └── image.route.js
│   |   |    └── index.js
│   |   |    └── review.route.js
│   |   |    └── user.route.js
│   |   └── app.js
│   |   └── server.js
|   ├── 📁 tests/
│   |   └── booking.test.js
│   |   └── city.test.js
│   |   └── hotel.test.js
│   |   └── review.test.js
│   |   └── setup.js
│   |   └── user.test.js
|   └── .env.example
|   └── .gitignore
|   └── jest.config.js
|   └── package-lock.json
|   └── package.json

⚙️ Setup & Installation

Clone this repository:

git clone https://github.com/Clic-stack/Booking-App.git

Install dependencies:
```
npm i
```
Configure enviroment variables:

Changes file name .env.example to .env
Modify variable values.
Example configuration:
```
PORT=3000
DATABASE_URL=postgres://user:password@localhost:5432/your_database
JWT_SECRET=your_secret_key
CLOUDINARY_URL=cloudinary://api_key:api_secret@cloud_name
```
💡 Quick Setup Note: This project includes default values (fallbacks) for the JWT_SECRET in development and testing environments. This facilitates rapid deployment and ensures the test suite runs out-of-the-box without extra security overhead.

Run local server to verify correct configurations
```
 npm run dev
```
Run tests
- Run all tests:
```
npm test
```
- Run individual test:
```
npm test name_file.test.js
```

🎨 Author

Developed by Clio Salgado as part of the Node.js & Backend module at Academlo, with the goal of consolidating skills in:

API design and documentation.
Database modeling with Sequelize & PostgreSQL.
Authentication and authorization with JWT.
Professional backend workflows and reproducible environments.

🔽 Versión en Español 🔽

🏨 Booking App

Tip

Nota de configuración rápida: Este proyecto incluye valores por defecto (fallbacks) para la JWT_SECRET en entornos de desarrollo y pruebas. Esto facilita un despliegue rápido y garantiza que la suite de tests se ejecute correctamente de forma inmediata, sin configuraciones de seguridad adicionales.

Sistema backend construído con Express, Sequelize y PostgreSQL para el manejo de reservaciones de hotel. Este proyecto proporciona una API robusta y completa para el manejo de usuarios, ciudades, hoteles, imágenes, reservaciones y reseñas. Asegurando seguridad, escalabilidad, pero por sobre todas las cosas una arquitectura que sea amigable con el usuario.

🌐 Despliegue

🚀 Backend: Servidor en línea con Render

🔗 https://booking-app-b5o8.onrender.com

📄 BookingApp: Documentación en línea con Postman

🔗 https://documenter.getpostman.com/view/48309056/2sBXVZnDx7

🌐 Repositorio en GitHub

🔗 https://github.com/Clic-stack/Booking-App

🟢 Garantía de Calidad Técnica (QA) y Automatización

¿Qué significa el sello "passing" al inicio de este proyecto? En un entorno profesional, no basta con que una aplicación simplemente "funcione"; debe ser confiable. Este proyecto implementa Pruebas de Integración de Escenario Real. Esto significa que cada vez que se realiza un cambio en el código, un sistema de vigilancia automática garantiza que cada componente (Base de Datos, Seguridad y Funciones) opere correctamente, incluso al manejar altos volúmenes de información.

Sello Verde (Passing): Indica que el código es sólido y seguro. Ha superado todas las inspecciones de calidad y está listo para ser utilizado en un entorno de producción real sin errores inesperados.
Sello Rojo (Failing): Actúa como un freno de emergencia. Si se detecta un error técnico, el sistema bloquea automáticamente cualquier actualización antes de que pueda afectar al usuario final o comprometer la integridad de los datos.

En resumen: Este sello es tu garantía de que el software ha sido construido bajo estándares profesionales, priorizando la estabilidad y la protección de los datos en todo momento.

📊 Arquitectura de la Base de Datos

erDiagram
    USER ||--o{ BOOKING : "makes"
    USER ||--o{ REVIEW : "writes"
    HOTEL ||--o{ BOOKING : "receives"
    HOTEL ||--o{ REVIEW : "has"
    HOTEL ||--o{ IMAGE : "displays"
    CITY ||--o{ HOTEL : "contains"

    USER {
        string firstName
        string lastName
        string email
        string password
    }
    HOTEL {
        string name
        text description
        float price
        float averageRating
    }
    BOOKING {
        date checkIn
        date checkOut
    }
    REVIEW {
        int rating
        text comment
    }

🎯 Objetivos del Proyecto

Este proyecto fue diseñado para:

Implementar un CRUD que contenga endpoints para Usuarios, Ciudades, Hoteles, Imágenes, Reservaciones y Reseñas.
Proveer autenticación y autorización a usuarios usando JWT.
Permitir el filtrado de hoteles usando Query Params, ya sea por ciudad o nombre con el cálculo de la calificación promedio de reseñas.
Soportar reservaciones ligadas a usuarios logueados sin alterar las restricciones de integridad en la base de datos.
Entregar documentación profesional y flujos de trabajo reproducibles para el desarrollo colaborativo.

🚀 Funcionalidades Principales y Detalles de Implementación

✅ Cobertura Total de la API (25 Endpoints): 100% de los endpoints requeridos implementados, incluyendo rutas públicas y privadas, asegurando el manejo completo del sistema para Usuarios, Ciudades, Hoteles, Imágenes, Reservaciones y Reseñas.
🧪 Suite de Testing Profesional: Implementación robusta de Jest y Supertest, con tests automatizados para cada endpoint garantizando su fiabilidad, previniendo regresiones en la lógica de negocio.
🔐 Seguridad y Autenticación Avanzada:
- Sistema de usuarios logueados con JWT (JSON Web Tokens).
- Rutas protegidas al requerir tokens válidos para operaciones sensibles (Reservaciones, Reseñas, Manejo de usuarios, etc.).
- Contraseña hasheada usando bcrypt y cabeceras de seguridad con Helmet.
📂 Gestión de Archivos Multimedia: Integrando Cloudinary para el alojamiento y gestión profesional de imágenes, gestionado a través de Multer para cargas de archivos sin interrupciones.
📊 Procesamiento Inteligente de Datos:
- Cálculo Dinámico de Calificaciones: Generando automáticamente un campo average (promedio) para los hoteles, calculando el puntaje a partir de todas las reseñas relacionadas.
- Consultas Avanzadas Busquedas inteligentes para hoteles por nombre y Id de ciudad.
- Paginación optimizada Implementando lógica offset y perPage para reseñas, garantizando un alto rendimiento y escalabilidad.
🛠️ Arquitectura Limpia y & Flujos de Trabajo Confiables:
- Manejo Centralizado de Errores para lograr respuestas de API predecibles.
- Modelado Relacional en la Base de Datos con Sequelize y PostgreSQL, garantizando la integridad de los datos y aplicando restricciones de actualización estrictas (previniendo la modificación de userId en reservaciones).

📊 Resumen de Arquitectura de Proyecto

Backend: Node.js & Express.
Database: PostgreSQL with Sequelize ORM.
Storage: Cloudinary API.
Documentation: Postman (Online).
Deployment: Render.

🧪 Suite de Testings

El aseguramiento en la calidad es una prioiridad en este proyecto. Es por ello que se desarrolló una suite integral de tests usando Jest y Supertest para validar cada capa dentro de la API.

Cobertura Total: 22/25 endpoints testeados (100% de la lógica de negocio principal).
CI/CD Pipeline: ✅ Flujos de trabajo automatizados con Pruebas de Integración Realmediante GitHub Actions, validando la interacción real con la base de datos PostgreSQL. Cada push o pull request activa la suite completa de pruebas para garantizar la estabilidad tanto en entornos de producción como de desarrollo.
Alcance:
- Pruebas de Integración: Asegurando una interacción fluida entre rutas, controladores y la base de datos PostgreSQL para Usuarios, Ciudades, Hoteles, Reservaciones y Reseñas.
- Pruebas de Seguridad: Verificación de autorización con JWT y acceso restringido a rutas privadas.
  
  Nota: Los endpoints de carga de imágenes se verifican mediante pruebas funcionales manuales a través de Postman para optimizar el rendimiento del CI/CD y el uso del almacenamiento de terceros.

Para correr los tests localmente:

npm test

💻 Tech Stack

Herramientas de Backend	Base de Datos	Seguridad y Middleware	Utilidades
Node.js	PostgreSQL	Helmet	bcrypt
Express	Sequelize	CORS	uuid
Morgan	pg/pg-hstore	JWT	multer
Cloudinary			streamifier

🧪 Cobertura en API

Los siguientes endpoints fueron implementados:

Usuarios

GET /users – Obtiene todos los usuarios (privado) ✅
POST /users – Crea un nuevo usuario (público) ✅
DELETE /users/:id – Elimina un usuario por ID (privado) ✅
PUT /users/:id – Actualiza un usuario por ID (privado) ✅
POST /users/login – Usuario Logueado (público) ✅

Ciudades

GET /cities – Obtiene todas las ciudades (público) ✅
POST /cities – Crea una nueva ciudad (privado) ✅
DELETE /cities/:id – Elimina una ciudad por ID (privado) ✅
PUT /cities/:id – Actualiza una ciudad por ID (privado) ✅

Hoteles

GET /hotels – Obtiene todos los hoteles (público) ✅
Soporta consultas: name, cityId Ejemplo: /hotels?name=Four%20Seasons&cityId=1
Incluye campos average con promedio de valoración de reseñas.
GET /hotels/:id – Obtiene un hotel por ID (público) ✅
POST /hotels – Crea un nuevo hotel (privado) ✅
DELETE /hotels/:id – Elimina un hotel por ID (privado) ✅
PUT /hotels/:id – Actualiza un hotel por ID (privado) ✅

Imágenes

GET /images – Obtiene todas las imágenes (privado) ✅*
POST /images – Crea una nueva imagen (privado) ✅*
DELETE /images/:id – Elimina una imagen por ID (privado) ✅*

*Validado mediante pruebas funcionales manuales (Postman)

Reservaciones

GET /bookings – Obtiene las reservaciones del usuario logueado (privado) ✅
POST /bookings – Crea una reservación (privado, userId = logged-in user) ✅
DELETE /bookings/:id – Elimina una reservación (privado) ✅
PUT /bookings/:id – Actualiza días de la reservación (privado, solo checkIn y checkOut) ✅

Reseñas

GET /reviews – Obtiene todas las reseñas (público) ✅
Supporta consultas: hotelId, offset, perPage para paginación.
Ejemplo: /reviews?hotelId=1&offset=0&perPage=10
POST /reviews – Crea una reseña (privado, userId = logged-in user) ✅
DELETE /reviews/:id – Elimina una reseña (privado) ✅
PUT /reviews/:id – Actualiza la calificación o el comentario de una reseña (privado, userId y hotelId no se pueden actualizar) ✅

📄 Scripts (package.json)

"scripts": {
  "dev": "node --watch --env-file=.env src/server.js",
  "start": "node src/server.js",
  "test": "node --env-file=.env node_modules/jest/bin/jest.js"
}

🗂️ Estructura de Proyecto

📁 BOOKING-APP
|   ├── 📁 node_modules/
|   ├── 📁 src/
│   |   └── 📁 config/
│   |   |    └── env.js
│   |   |    └── cloudinary.js
│   |   └── 📁 controllers/
│   |   |    └── booking.controller.js
│   |   |    └── city.controller.js
│   |   |    └── hotel.controller.js
│   |   |    └── image.controller.js
│   |   |    └── review.controller.js
│   |   |    └── user.controller.js
│   |   └── 📁 db/
│   |   |    └── connect.js
│   |   └── 📁 lib/
│   |   |    └── utils.js
│   |   └── 📁 middlewares/
│   |   |    └── auth.js
│   |   |    └── catchError.js
│   |   |    └── errorHandler.js
│   |   |    └── upload.js
│   |   └── 📁 models/
│   |   |    └── booking.model.js
│   |   |    └── city.model.js
│   |   |    └── hotel.model.js
│   |   |    └── Image.model.js
│   |   |    └── review.model.js
│   |   |    └── user.model.js
│   |   └── 📁 routes/
│   |   |    └── booking.route.js
│   |   |    └── city.route.js
│   |   |    └── hotel.route.js
│   |   |    └── image.route.js
│   |   |    └── index.js
│   |   |    └── review.route.js
│   |   |    └── user.route.js
│   |   └── app.js
│   |   └── server.js
|   ├── 📁 tests/
│   |   └── booking.test.js
│   |   └── city.test.js
│   |   └── hotel.test.js
│   |   └── review.test.js
│   |   └── setup.js
│   |   └── user.test.js
|   └── .env.example
|   └── .gitignore
|   └── jest.config.js
|   └── package-lock.json
|   └── package.json

⚙️ Configuración e Instalación

Clona este repositorio:

git clone https://github.com/Clic-stack/Booking-App.git

Instala dependencias:
```
npm i
```
Configura variables de entorno:

Cambia el nombre del archivo .env.example a .env
Modifica los valores de las variables.
Ejemplo de configuración:
```
PORT=3000
DATABASE_URL=postgres://user:password@localhost:5432/your_database
JWT_SECRET=your_secret_key
CLOUDINARY_URL=cloudinary://api_key:api_secret@cloud_name
```
💡 Nota de configuración rápida: El proyecto incluye valores por defecto (fallbacks) para la JWT_SECRET en entornos de desarrollo y prueba. Esto facilita un despliegue rápido y permite que la suite de tests funcione de inmediato sin configuraciones complejas de seguridad adicionales.

Corre el servidor locar para verificar que las configuraciones sean correctas:
```
 npm run dev
```
Corre tests.
- Corre todos los tests:
```
npm test
```
- Corre el test individualmente:
```
npm test name_file.test.js
```

🎨 Autor

Desarrollado por Clio Salgado como parte del módulo de Node.js y Backend en Academlo, con el objetivo de consolidar habilidades en:

Diseño y Documentación de una API.
Modelado de una base de datos realizada con Sequelize y PostgreSQL.
Autenticación y Autorización con JWT.
Flujos de trabajo de backend profesionales y entornos reproducibles.

Name		Name	Last commit message	Last commit date
Latest commit History 17 Commits
.github/workflows		.github/workflows
src		src
tests		tests
.env.example		.env.example
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json

Folders and files

Latest commit

History

Repository files navigation

🏨 Booking App

🌐 Deployment

🚀 Backend: Server online with Render

📄 BookingApp: Documentation online with Postman

🌐 GitHub Repository

🟢 Technical Quality Assurance (QA) & Automation

📊 Database Architecture

🎯 Project Goals

🚀 Key Features & Implementation Details

📊 Project Architecture Summary

🧪 Testing Suite

💻 Tech Stack

🧪 API Coverage

Users

Cities

Hotels

Images

Bookings

Reviews

📄 Scripts (package.json)

🗂️ Project Structure

⚙️ Setup & Installation

🎨 Author

🏨 Booking App

🌐 Despliegue

🚀 Backend: Servidor en línea con Render

📄 BookingApp: Documentación en línea con Postman

🌐 Repositorio en GitHub

🟢 Garantía de Calidad Técnica (QA) y Automatización

📊 Arquitectura de la Base de Datos

🎯 Objetivos del Proyecto

🚀 Funcionalidades Principales y Detalles de Implementación

📊 Resumen de Arquitectura de Proyecto

🧪 Suite de Testings

💻 Tech Stack

🧪 Cobertura en API

Usuarios

Ciudades

Hoteles

Imágenes

Reservaciones

Reseñas

📄 Scripts (package.json)

🗂️ Estructura de Proyecto

⚙️ Configuración e Instalación

🎨 Autor

About

Topics

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Contributors

Uh oh!

Languages