TutorPlan

TutorPlan Website

TutorPlan is a scheduling platform designed to streamline the coordination of tutoring sessions for both tutors and students. Inspired by the frustration of scheduling piano lessons, TutorPlan was founded in 2024 with the mission of simplifying the tutoring experience through intuitive booking, automatic reminders, and built-in messaging.

Mission

TutorPlan is dedicated to enhancing the tutoring experience by providing tools for effective communication and organization. Our platform aims to alleviate the inefficiencies associated with coordinating tutoring sessions through text messages, allowing tutors and students to focus on learning and growth.

Commitment

At TutorPlan, we are committed to continuous improvement. We value user feedback and actively strive to implement updates that meet the evolving needs of our community. Join us in our mission to transform tutoring into a stress-free experience. With TutorPlan, scheduling sessions becomes effortless, empowering tutors and students alike.

Technologies Used

• Backend: MySQL and Flask
• Frontend: React JS
• Design: Figma

Running the Backend Locally

To run the backend locally, follow these steps:

1. Clone this repository to your local machine.
2. Navigate to the repository dir TutorPlan
3. Install the necessary dependencies using pip install -r requirements.txt.
4. Ensure you have MySQL installed and running on your machine.
5. Once your database is set up, you can start the Flask server by running python -m api.v1.app.

Running the Frontend Locally

To run the frontend locally, follow these steps:

1. Clone this repository to your local machine if you haven't already.
2. Navigate to the frontend directory.
3. Install the necessary dependencies using npm install.
4. After the installation is complete, you can start the development server by running npm run dev.
5. The frontend should now be running locally and accessible through your web browser at http://localhost:5173.

Feel free to explore and contribute to TutorPlan! We welcome your feedback and contributions as we continue to improve our platform.

Contributing

We welcome contributions to TutorPlan! If you would like to contribute to this project, please check out our Contributing Guidelines.

Licensing

This project is licensed under the MIT License - see the LICENSE.md file for details.

Feel free to explore and contribute to TutorPlan! We welcome your feedback and contributions as we continue to improve our platform.