Skip to content

StuddyBuddy is an intelligent study planner for students. It helps manage schedules, track task progress, and provides personalized study recommendations. Features include a schedule organizer, task tracking, study suggestions, and break reminders based on the Pomodoro technique.

Notifications You must be signed in to change notification settings

sachaloeb/StudyBuddy

Repository files navigation

🧑‍🎓 StudyBuddy: Your Personal Study Assistant 📚

Welcome to StudyBuddy, a comprehensive web application designed to help students manage their time effectively, stay productive, and achieve their academic goals! 🚀

🌟 Features

  1. 📅 Schedule Organizer
  • Input classes, assignments, exams, and personal study events.
  • Automatically generates a weekly timetable based on deadlines and priorities.
  1. Task Tracking
  • Mark tasks as completed and visualize your weekly progress with a bar chart.
  • Stay on top of your goals with intuitive tracking.
  1. 📖 Study Recommendations
  • Personalized insights to help you focus on weaker areas.
  • Get resource recommendations like tutorials and practice problems.
  1. Break Reminders
  • Notifications to remind you to take breaks using the Pomodoro technique.
  • Maintain your energy and avoid burnout.

🛠️ Tech Stack

  • Frontend: HTML, CSS, JavaScript (React)
  • Backend: JavaScript (Express.js), Python (data analysis & AI)
  • Database: NoSQL (MongoDB)

🚀 Installation Guide

Follow these steps to set up StudyBuddy on your local machine:

  1. Clone the Repository
git clone https://github.com/sachaloeb/StudyBuddy.git
cd StudyBuddy
  1. Install Dependencies
  • Open the project in IntelliJ or your preferred IDE.
  • Ensure you have Java, Maven, Node.js, React.js and Express.js installed.

▶️ Run project

Run Backend API

cd src/main/Backend
npm run dev

Run React Frontend

cd src/main/Frontend
npm start

📂 Project Structure

  • Frontend:
    • src/main/Frontend: React frontend.
  • Backend:
    • src/main/Backend: Core application logic and Express API connected to MongoDB database.

🛠️ Current Limitations

  • React frontend is not fully complete.
  • Advanced AI-based scheduling is under development.

🧑‍💻 Contribution Guidelines

We welcome contributions from the community! Here’s how you can help:

  • Fork the repository and make your changes.
  • Submit a pull request with a detailed explanation of your work.

🏆 Roadmap

  • Add role-based access.
  • Enhance task scheduling with machine learning algorithms.
  • Develop an intuitive mobile-friendly UI.

❤️ Acknowledgments

  • Pomodoro Technique for inspiring break reminders.
  • Tutorials and open-source libraries that made this project possible.

📧 Contact

Have questions or suggestions? Feel free to reach out!

About

StuddyBuddy is an intelligent study planner for students. It helps manage schedules, track task progress, and provides personalized study recommendations. Features include a schedule organizer, task tracking, study suggestions, and break reminders based on the Pomodoro technique.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published