Calendar Event Scheduling

This project is a Spring Boot application that provides a RESTful API for scheduling calendar events. Users can create busy slots, fetch events, find conflicts, and schedule events with other users.

Features

• Create busy slots for individual users.
• Fetch events for a specific user or multiple users.
• Identify conflicting events for a user on a particular day.
• Find the most favorable upcoming empty slot for a set of users and a specific duration.
• Schedule events with a defined start and end time involving multiple users

Prerequisites

• Java 11 or later
• Maven
• Docker

Setup

1. Start Docker Desktop.
2. Clone the repository
3. Navigate to the project directory
4. Build and run the spring boot application. mvn clean install and then mvn spring-boot:run

API Endpoints

Base url : http://localhost:8080

Create Busy Slot

• POST /busy
• Body:

{
 "userId": 1,
 "startTime": "2023-12-09T10:00:00",
 "endTime": "2023-12-09T11:00:00"
}

Fetch User Events

-GET /{userId}

Fetch Conflict Events

-GET /conflicts/{userId}?date=2023-12-01

Fetch Favourable Slot

-POST /favaourable-slot

-Body:

{
  "organiserId": 1,
  "participantIds": [2, 3],
  "durationMinutes": 120
}

Create Event with Users

-POST /create-event

-Body:

{
  "organiserId": 1,
  "participantIds": [2, 3],
  "startTime": "2023-12-10T15:00:00",
  "endTime": "2023-12-10T17:00:00"
}

Reasoning

SpringBoot

It offers a vast ecosystem, including Spring Data JPA for database interactions.

PostgreSQL

open-source relational database that supports complex queries and transactions.

Docker

allows for easy setup and deployment of the application and its dependencies, ensuring consistency across different environments.

RestAPIs

enables easy integration with various clients, including web and mobile applications, and follows stateless client-server architecture principles.

Future Improvements

• Notifications and Reminders
• Time Zone Support
• Recurring Events
• Event invitations
• User Authentication and Authorization

Testing

You can test the API endpoints using tools like Postman or cURL.

Reference Documentation

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image
• Spring Web
• Spring Data JPA
• Spring Boot DevTools

Guides

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring
• Accessing Data with JPA