hroney / tutor-scheduling

Tutor Sign-up Application

Overview

This project consists of a backend API built with Flask and a frontend application using React. The application facilitates the sign-up and management of tutoring sessions. Tutors can apply to join, and students (tutees) can sign up for sessions based on tutor availability.

Backend API

Technologies Used

• Flask
• Flask-RESTful
• SQLAlchemy

Installation

1. Clone the repository:

   git clone <repository_url>
   cd <repository_directory>

2. Create and activate a virtual environment:

   python3 -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install the dependencies:

   pip install -r requirements.txt

4. Set up the database:

   flask db upgrade

Running the Application

python app.py

The API will be accessible at http://localhost:5555.

API Endpoints

Index

• GET /
  • Returns a welcome message and available endpoints.

Sessions

• GET /sessions
  • Returns a list of all sessions.
• POST /sessions
  • Creates a new session.

Tutors

• GET /tutors
  • Returns a list of all tutors.
• POST /tutors
  • Creates a new tutor.

Tutees

• GET /tutees
  • Returns a list of all tutees.
• POST /tutees
  • Creates a new tutee.

Scheduled Days

• GET /scheduled_days
  • Returns a list of all scheduled days.
• POST /scheduled_days
  • Creates a new scheduled day.

Courses

• GET /courses
  • Returns a list of all courses.
• POST /courses
  • Creates a new course.

Individual Resources

• Sessions by ID

  • GET /sessions/<int:id>
  • PATCH /sessions/<int:id>
  • DELETE /sessions/<int:id>

• Tutors by ID

  • GET /tutors/<int:id>
  • PATCH /tutors/<int:id>
  • DELETE /tutors/<int:id>

• Tutees by ID

  • GET /tutees/<int:id>
  • PATCH /tutees/<int:id>
  • DELETE /tutees/<int:id>

• Sessions by Tutor ID

  • GET /tutors/<int:id>/sessions

• Sessions by Tutee ID

  • GET /tutees/<int:id>/sessions

• Tutee by Student Number

  • GET /tutees/<int:student_number>/student_number

Frontend Application

Technologies Used

• React
• React Router
• Formik

Installation

1. Navigate to the frontend directory:

   cd frontend

2. Install the dependencies:

   npm install

Running the Application

npm start

The application will be accessible at http://localhost:3000.

Components

App.js

• Main application component that sets up the layout including NavBar, Outlet, and Sidebar.

Schedule.js

• Displays the weekly schedule of sessions and allows for sign-up for available slots.

SessionCard.js

• Represents an individual session card. It shows session details and allows users to sign up for a session if it's available.

SignUpForm.js

• Form component for signing up for a tutoring session.

Apply.js

• Displays the application form for tutors to apply to join the platform.

ApplyForm.js

• Form component for tutor application including validation and submission handling.

Usage

Sign Up for a Session

1. Navigate to the schedule page.
2. Click on an available time slot to sign up.
3. Fill out the form with your details and submit.

Apply to be a Tutor

1. Navigate to the application page.
2. Fill out the tutor application form including name, certification level, available days, and courses.
3. Submit the form and wait for confirmation.

Contributing

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes and commit them (git commit -m 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Open a pull request.

License

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