🦁 Hotel Booking System

A backend application for hotel booking system where guests can create bookings and will be assigned to appropriate rooms. Guests can register, login, logout, create a booking and so much more.

🦎 Features

• Guests can perform basic authentication which include registration, login, logout, refresh access token.
• Guests, when only logged in, can create a new booking, get a booking or update a booking.
• Guests can get their account information only when logged in.

🐧 Tech Stack

• Node.js: JavaScript runtime environment.
• Typescript: JavaScript with syntax for types.
• Express: Web framework for Node.js.
• PostgreSQL: SQL database.
• Prisma: ORM for managing database operations.
• Docker: Open-source software for deploying and running of containerized applications.
• Redis: NoSQL database management software.

🫎 Prerequisites

• Node.js (at least version 20.14.0)
• pnpm (version 9.x)
• Docker

🐳 Installation

1. Clone the repository

   git clone https://github.com/maliByatzes/hotel-booking-system
   cd hotel-booking-system

2. Install the dependencies

   pnpm install

🤖 Configuration

1. Create a .env file int project's root directory and add all the requred environment variables, also you can change the values to your liking:

   PORT=8000
   NODE_ENV=development
   DATABASE_URL="postgresql://admin:secret@localhost:5432/hoteldb?schema=public"
   POSTGRES_HOST=127.0.0.1
   POSTGRES_PORT=5432
   POSTGRES_USER=admin
   POSTGRES_PASSWORD=secret
   POSTGRES_DB=hoteldb
   TOKEN_SECRET_KEY=767e0ea4725fade20882c396f503f5ec1fb12fea94f6af92e300504aaf3c053fbda4cc6942a02b25db1a667bd7992c9637fd7e29aa304569d73cf13f57f9cbe1

   You can also generate a new secret key by running:

   node -e "console.log(require('crypto').randomBytes(64).toString('hex'))"

2. Create a postgres.env file in the project's root directory and add the postgres environment variables:

   POSTGRES_HOST=127.0.0.1
   POSTGRES_PORT=5432
   POSTGRES_USER=admin
   POSTGRES_PASSWORD=secret
   POSTGRES_DB=hoteldb

3. Create postgres and redis containers by running:

   make docker-up

4. Run migrations:

   npx prisma migrate dev

5. Run seed script to populate the database with data:

   pnpm run seed

🐬 Usage

1. Run the application

   make server

2. To view PostgreSQL database you can use any client, but I made us of pgcli. Follow the installation instructions on their website. You can use the tool like this:

   pgcli -h localhost -p 5432 -U admin -d hoteldb
   # When prompted for password use "secret"

The server should be running on http://localhost:8000.

🦩 API Endpoints

🐛 Healthcheck

• GET: /api/healthcheck - Check if the server is up and running.

  curl --location 'http://localhost:8000/api/healthchecker'

🦬 Authentication

NOTE: If you are chad and using cURL tool directly instead of a wrapper like postman, tokens are sent over cookies so you need to set the Bearer token to be authenticated. Also note the data in the request body can be changed.

• POST: /api/v1/auth/register - Register a new guest.

  curl --location 'http://localhost:8000/api/v1/auth/register' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "firstName": "test",
      "lastName": "user",
      "emailAddress": "[email protected]",
      "phoneNumber": "0123456790",
      "password": "password123",
      "passwordConfirm": "password123"
  }'

• POST: /api/v1/auth/login - Login a guest.

  curl --location 'http://localhost:8000/api/v1/auth/login' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "emailAddress": "[email protected]",
      "password": "password123"
  }'

• GET: /api/v1/refresh - Refresh access token.

  curl --location 'http://localhost:8000/api/v1/auth/refresh' \
  --header 'Authorization: Bearer <access_token>'

• GET: /api/v1/logout - Logout a guest

  curl --location 'http://localhost:8000/api/v1/auth/logout' \
  --header 'Authorization: Bearer <access_token>'

🦫 Guest

• GET: /api/v1/guest/me - Get logged in guest's information.

  curl --location 'http://localhost:8000/api/v1/guests/me' \
  --header 'Authorization: Bearer <access_token>'

🐼 Booking

• POST: /api/v1/booking/new - Create a new booking.

  curl --location 'http://localhost:8000/api/v1/booking/new' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <access_token>' \
  --data '{
      "checkinDate": "2012-02-12T22:00:00.000Z",
      "checkoutDate": "2012-10-24T22:00:00.000Z",
      "numAdults": 1,
      "numChildren": 2,
      "bookingAmount": 400,
      "addonName": "Spa Package",
      "roomClassName": "Standard"
  }'

• GET: /api/v1/booking/:bookingId - Get one booking by id.

  curl --location 'http://localhost:8000/api/v1/booking/1' \
  --header 'Authorization: Bearer <access_token>'

• PATCH: /api/v1/booking/:bookingId - Update one booking.

  curl --location --request PATCH 'http://localhost:8000/api/v1/booking/2' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <access_token>' \
  --data '{
     "numChildren": 3
  }'

🐊 License

This project is licensed under the MIT License - see the LICENSE file for details.

🦔 Contact

maliByatzes - [email protected]

Project Link - https://github.com/maliByatzes/hotel-booking-system