Skip to content

DJ-Devil-coder/StudyForge

Repository files navigation

StudyForge

Plan Smarter. Score Higher.

StudyForge is a free AI-powered smart study planner that works for any exam you want to prepare for. Built with Python Flask on the backend and pure HTML/CSS/Vanilla JS on the frontend, it uses the Google Gemini API (free tier) to generate timetables, tasks, and provide actionable advice.

🚀 Features

  • Multi-step onboarding with dynamic subject detection
  • Personalized AI-generated study timetable and daily tasks
  • Mock test tracking with AI analysis
  • Detailed analytics with charts and heatmap
  • Reminder system with browser notifications
  • Pomodoro timer built-in
  • Full data export & reset
  • Dark SaaS-style responsive design
  • Uses SQLite via Flask-SQLAlchemy, requires no manual setup
  • Offline detection and smart Python fallback when Gemini limits hit

🧩 Tech Stack

  • Frontend: HTML5, CSS3, Vanilla JavaScript
  • Backend: Python Flask
  • Database: SQLite (Flask-SQLAlchemy)
  • AI: Google Gemini API (gemini-1.5-flash model, free tier)
  • Charts: Chart.js (CDN)
  • Icons: Font Awesome 6 (CDN)
  • Fonts: Google Fonts - Sora + DM Sans

📥 Installation

  1. Clone or download this repository.
  2. cd StudyForge
  3. Create a virtual environment: python -m venv venv and activate it.
  4. Install dependencies:
    pip install -r requirements.txt
  5. Get a free Gemini API key:
    • Visit aistudio.google.com
    • Sign in with your Google account (no credit card).
    • Navigate to the API keys section and create a new key.
  6. Create a .env file in the project root with:
    GEMINI_API_KEY=your_key_here
    SECRET_KEY=studyforge_secret_2024
  7. Run the app:
    python app.py
  8. Open your browser at http://localhost:5000

🔑 Login & Accounts

StudyForge now supports multiple users. Upon first launch you will be prompted to register with your name, email and a password. After registration (or subsequent logins) your profile, timetable, tasks, mock tests and logs are tied to your account and stored permanently.

  • If you previously used StudyForge before the login feature was added, the existing profile is automatically migrated when you sign up.
  • Use the Remember Me checkbox on the login page to stay signed in for 30 days.
  • A Logout link lives in the sidebar footer.

All pages and APIs are protected; unauthenticated visitors are redirected to the login screen.

📝 Usage

  • Enter your name, exam details and subjects during onboarding.
  • Let Gemini AI craft a customized study plan and daily tasks.
  • Track mocks, log study sessions, view analytics, and ask the AI coach questions.
  • Adjust your profile or reset/export data from settings.

🛡️ Offline & Fallback Support

If the Gemini API key is missing/invalid or rate limits are hit, StudyForge automatically uses smart Python fallback functions to generate plans and tasks, ensuring full functionality without external dependencies.

✅ Requirements Summary

All files are complete and the app should run perfectly on first start after following the steps above.

Enjoy studying smarter with StudyForge! 🎓

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors