Tech Challenge Repository

This repository contains the solution for Tech Challenge. The challenge is to implement a campsite reservation system using Java, Spring Boot, JPA, REST api and JUnit test.

Table of Contents

• Overview
• Features
• Installation
• Usage
• Testing

Overview

This repository provides a campsite reservation system implemented in Java with Spring Boot. The system allows users to make reservations for a campsite, check availability, modify existing reservations, and cancel reservations. It follows the specified requirements and constraints outlined in the challenge.

For POC purpose, this application was built using SpringBoot H2 to persist data, which is in-memory relational database engine. So once the server is restarted, the DB will be purged.

Features

• Reservation creation: Users can make reservations for the campsite by providing their email, full name, arrival date, and departure date.
• Availability check: Users can check the availability of the campsite for a specific date range.
• Reservation modification: Users can modify existing reservations, including changing the arrival or departure date.
• Reservation cancellation: Users can cancel their reservations, freeing up the campsite for others.
• Concurrency handling: The system is designed to handle concurrent reservation requests and ensures data consistency.

Installation

To install and set up the campsite reservation system locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/fredfoxtrot/tech-challenge.git
   

2. Navigate to the project directory:

   cd tech-challenge
   

3. Build the project using Maven:

   mvn clean install
   

4. Run The Application:

   mvn spring-boot:run
   

The campsite reservation system should now be up and running locally on http://localhost:8080.

Usage

Once the campsite reservation system is running, you can interact with it using the following endpoints:

• GET /api/v1/campsite/availability: Retrieve the availability of the campsite for a specific date range.
• POST /api/v1/campsite/reservation: Make a reservation by providing the required information.
• PUT /api/v1/campsite/reservation/{reservationId}: Modify an existing reservation by providing the reservation ID and updated details.
• DELETE /api/v1/campsite/reservation/{reservationId}: Cancel an existing reservation by providing the reservation ID.

Make sure to refer to the API documentation or Swagger UI for detailed information on request payloads and response formats.

Testing

I highly encourage you to utilize the embedded Postman collection to facilitate your testing process.

The campsite reservation system includes automated tests to ensure the correctness of the implemented features.

The tests cover various scenarios, including reservation creation, availability check, reservation modification, cancellation, and concurrency handling.

To run the tests, use the following command:

mvn clean install