Skip to content

Latest commit

 

History

History
192 lines (135 loc) · 7.23 KB

Readme.md

File metadata and controls

192 lines (135 loc) · 7.23 KB
Raw

Vbnb

Project Description

Vbnb is a comprehensive listing service application that allows users to manage and interact with property listings. It provides functionalities for user authentication, property management, reservations, ratings, and more.

Architecture

The application is containerized using Docker and consists of four main services:

  1. Production PostgreSQL Database
  2. Test PostgreSQL Database
  3. Backend Service (Java 17 Spring Boot)
  4. Frontend Service (React with Vite)

Color Palette

Vbnb color palette

  • Brand color: #FF6F00
  • Background: #FFFFFF
  • Borders and Lines: #E0E0E0
  • Links: #3b82f6

UML Diagram

vbnb_uml

Authentication

This application uses JWT (JSON Web Token) for authentication. Users can register and log in via the /api/v1/auth endpoints. Upon successful authentication, the server returns a JWT which must be included in the Authorization header as a Bearer token for subsequent requests to protected endpoints.

The endpoints below are marked with their authentication requirements:

  • 🔓 Public: No authentication required
  • 🔒 Authenticated: Requires a valid JWT
  • 👑 Admin: Requires a valid JWT with admin role

API Endpoints

Authentication Controller /api/v1/auth

  • POST /register: Register a new user 🔓
  • POST /authenticate: Authenticate a user 🔓

Category Controller /api/v1/category

  • POST /: Create a category 👑
  • GET /all: Get all categories 🔓
  • DELETE /{id}: Delete category by ID 👑

Characteristic Controller /api/v1/characteristic

  • POST /: Create characteristic 👑
  • GET /all: Get all characteristics 🔓
  • PUT /{id}: Update characteristic by ID 👑
  • DELETE /{id}: Delete characteristic by ID 👑

City Controller /api/v1/city

  • POST /: Create city 👑
  • GET /all: Get all cities 🔓
  • GET /{id}: Get city by ID 👑
  • PUT /{id}: Update city by ID 👑
  • DELETE /{id}: Delete city by ID 👑

Favorite Controller /api/v1/favorite

  • POST /: Add a listing to favorites 🔒
  • DELETE /: Delete a listing from favorites 🔒
  • GET /{userEmail}: Get favorites by user email 🔒

Rating Controller /api/v1/rating

  • POST /: Add rating to a listing 🔒
  • PUT /: Update the rating of a listing 🔒
  • GET /get/{listingId}: Get ratings of a listing 🔓
  • GET /info/{listingId}: Get amount of times rated and average of a listing 🔓

Reserve Controller /api/v1/reserve

  • POST /: Add a reserve for a listing 🔒
  • DELETE /: Delete a reserve for a listing 🔒
  • PUT /: Update a reserve for a listing 🔒
  • GET /listing/{listingId}: Get the reserves of a listing 🔓
  • GET /user/{userEmail}: Get the reserves of a user (historically) 🔒
  • GET /current/{userEmail}: Get the current reserves of a user 🔒

User Controller /api/v1/user

  • GET /all: Get all users 👑
  • PUT /update/{userId}: Update user role 👑
  • DELETE /delete/{userId}: Delete a user 👑

Listing Controller /api/v1/listing

  • POST /create: Create a listing 👑
  • GET /all: Get all listings 🔓
  • PUT /update/{id}: Update listing by listing ID 👑
  • GET /get/{id}: Get listing by listing ID 🔓
  • DELETE /delete/{id}: Delete listing by listing ID 👑
  • GET /category/{category}: Get listings by category name 🔓
  • GET /city/{city}: Get listings by city name 🔓
  • GET /available: Get available listings (non-reserved) for a range of dates 🔓
  • GET /by-city-category: Get listings by city and category names 🔓
  • GET /available/by-city: Get available listings for a range of dates and city name 🔓
  • GET /available/by-category: Get available listings for a range of dates and category name 🔓
  • GET /available/by-category-city: Get available listings for a range of dates, category name and city name 🔓
  • GET /full: Get listing with more information 👑

Exception Handling

The application handles the following exceptions:

  • ResourceNotFoundException
  • UnauthorizedException
  • EmailAlreadyRegisteredException
  • ResourceAlreadyExistentException
  • ListingUnavailableForReserves

Installation and Setup

  1. Ensure you have the following prerequisites installed on your system:

  2. Clone the repository:

    git clone [repository-url]

  3. Set up environment variables:

    • Locate the .env-example file in the root directory of the project.
    • Create a new file named .env in the same directory.
    • Copy the contents of .env-example into .env.
    • Fill in the required environment variables in the .env file.

  4. External service requirements:

    • Cloudinary account:
    • Gmail account:
    • JWT authentication:

      • Generate a Base64-encoded secret key for JWT authentication. You can use an online tool or run this command in your terminal:

        openssl rand -base64 32

  5. Update the .env file with the obtained credentials and keys.

  6. Generate the JAR file:

    • Navigate to the backend/vbnb project directory.

    • Run the following Maven command to generate the JAR file:

      mvn -Dmaven.test.skip=true package

    • The JAR file is going to be generated on /backend/vbnb/target with the name vbnb-0.0.1-SNAPSHOT.jar

    • Create a /jar directory on /backend/vbnb

    • Move the generated JAR file to the /jar folder.

  7. Build and run the Docker containers:

    docker compose --env-file .env up -d

Web Setup

  1. Log in as admin with the credentials added to the .env file

  2. Then we recommend to use the images on assets or similars to setup the categories, characteristics and listings

    Note: ensure characteristics and categories are png icons, you can obtain them from Iconify

  3. Ensure to add the All category as it acts as a filter cleaner

Note: The Docker Compose file uses the environment variables defined in the .env file. Ensure all required variables are properly set before running the containers.

For more detailed information on setting up and using these services, please refer to their official documentation: