Tutor-Tutee Meeting API

Description

The Tutor-Tutee Meeting API is a Flask-based RESTful API designed to facilitate 1:1 meeting arrangements between tutors and tutees. It supports managing availability for tutors, class bookings for tutees, and handles various class-related operations. This project aims to simplify the scheduling process for educational sessions, making it easier for tutors to open their availability and for tutees to find and register for classes.

Features

• Tutor Availability Management: Tutors can create, update, and delete their available times.
• Class Registration: Tutees can search for available classes based on time slots or tutor availability and register for classes.
• Flexible Scheduling: Supports 30-minute and 60-minute classes, ensuring that each class starts only at the beginning of the hour or half-hour.
• Persistent Storage: Uses SQLAlchemy with SQLite for data persistence, ensuring data is saved across service restarts.

Code Structure Overview

• app.py (Application Entry Point): This is the root file of the project, responsible for initializing the Flask application and tying together various components of the project. Running this file starts the web server and serves the API endpoints defined within the project.

• /api Directory (Endpoint Definitions): Contains the code that defines the API endpoints for handling tutor and tutee operations. Each file within this directory corresponds to a specific set of related functionalities, such as managing tutor availability or processing tutee class registrations.

• /models Directory (Database Models): Hosts the SQLAlchemy model definitions used by the application. This directory also includes the initialization code for the database, which is executed when app.py is run. The models define the structure of the database tables and the relationships between them, facilitating data persistence and retrieval operations.

• /utils Directory (Utility Functions): Contains various utility functions that support the main API logic. These functions are designed to check the validity of incoming data and requests, enhancing the robustness and security of the API. By abstracting common validation and utility operations into this directory, the code within the /api endpoints is kept more concise and maintainable.

Endpoints

Tutor Availability

• POST /api/add_time: Add availability for a tutor.
• DELETE /api/delete_time: Remove a specific availability slot for a tutor.

Tutee Search Classes

• GET /api/find_classes: Find possible times to have classes for a specified time period.
• GET /api/find_tutors: Find available tutors in a specific day of week and time of day.

Register and View Classes

• PUT /api/register_class: Register for a class.
• GET /api/view_registered_class: View registered classes.

Installation

Ensure you have Python 3 and pip installed on your system.

1. Clone the repository:

git clone https://github.com/juneharold/TutoringPlatformAPI.git

2. Navigate to the project directory:

cd TutoringPlatformAPI

3. Install dependencies:

pip install -r requirements.txt

How To Run

From the root directory of the project, run the following command:

python3 app.py

This will start the Flask application on http://127.0.0.1:5000/.

How To Test

The project includes automated test scripts for testing all the API endpoints. Make sure to have curl and jq installed. The test cases have to be run in order for the code to output correctly. To run these tests:

cd tests
./run_all_tests.sh

Ensure you have granted execution permissions to the test scripts:

chmod +x ./testcase_scripts/*.sh
chmod +x run_all_tests.sh