Skip to content

Latest commit

 

History

History
71 lines (57 loc) · 2.52 KB

README.md

File metadata and controls

71 lines (57 loc) · 2.52 KB

FocusFlow: Study Plan Generator

🚀 About the Project

FocusFlow is a web-based application that helps students organize their study routine and achieve their academic goals efficiently.

Using AI, FocusFlow generates personalized study plans based on user input such as goals, deadlines, and preferences. The app also allows for customization in terms of study session lengths, break times, and frequency of work (e.g., every other day).

🎯 Key Features

  • AI-Powered Study Plans: Generate customized study schedules based on your academic goals, deadlines, and personal preferences.
  • Dynamic Calendar View: Visual calendar to display your study plan and manage tasks easily.
  • Personalized Preferences: Adjust session lengths, breaks, and work frequency (work every other day, etc.).
  • Responsive Design: Works seamlessly across devices for a smooth experience wherever you go.

🌸 Figma Link

https://www.figma.com/proto/URMUTFXrbqdgodmtNqFw0F/Focus-Flow---Clean-Version?node-id=2-2&p=f&t=ZiG269o86urbuhmu-1&scaling=scale-down&content-scaling=fixed&page-id=0%3A1&starting-point-node-id=2%3A2&show-proto-sidebar=1

🔧 Technologies Used

  • React + libraries
  • HTML/CSS
  • Javascript
  • Node.js
  • Express.js
  • OpenAI API

🌱 How to Run the Project Locally

Prerequisites

  • Node.js
  • npm (Node Package Manager)

Steps:

  1. Clone the repository to your local machine:
    git clone https://github.com/marwazaryab/FocusFlow.git
  2. Navigate into the project directory:
    cd FocusFlow
  3. Install the backend dependencies:
    npm install
  4. Install the frontend dependencies:
    cd client
    npm install
  5. Start the server and frontend: For the backend server:
    cd backend
    npm run server
    For the frontend React app:
    npm start
  6. Open your browser and navigate to http://localhost:3000 to see the app in action!

🌷 Images

intro study_plan generated

👷‍♀️ Contributors

credits