Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

📚 StudyAI — Intelligent Study Platform

An AI-powered study tool for students. Upload PDFs, generate summaries, quizzes, flashcards, essay outlines, and more — all free, no login required.

Free · No login · No cloud storage · API key secured server-side


✨ Features

Tool Description
💬 Chat General AI academic assistant
📄 Chat with PDF Upload any PDF and ask questions about it
📝 Summarizer Structured summaries from PDFs or pasted text
🎯 Quiz Generator Auto-generated MCQs with answers
🃏 Flashcards Q&A flashcard sets for active recall
🧠 Concept Explainer Any concept explained at your level
📖 Essay Helper Outlines, drafts, and essay review
🔢 Problem Solver Step-by-step STEM problem solving
🌍 Translate & Learn Academic translation with bilingual notes
📅 Study Planner Personalized study plans with daily schedules

🚀 Quick Start (Local)

1. Clone the repo

git clone https://github.com/your-username/studyai.git
cd studyai

2. Install dependencies

pip install -r requirements.txt

3. Get your free Groq API key

  1. Go to console.groq.com
  2. Create a free account — no credit card needed
  3. Generate an API key

4. Configure your API key(s)

cp .env.example .env

Open .env and fill in whichever keys you want to use:

Key Where to get it Required?
GROQ_API_KEY console.groq.com For Groq models (Llama, Mixtral, Gemma)
GEMINI_API_KEY aistudio.google.com/app/apikey For Gemini 1.5 Flash / Pro

You need at least one. Both are free with no credit card.

5. Run

streamlit run app.py

Open http://localhost:8501 in your browser.


☁️ Deploy to Streamlit Cloud (Free)

  1. Push this repo to GitHub (git push) — .env stays local, it is gitignored
  2. Go to share.streamlit.io and click New app
  3. Select your repo, set app.py as the entry point
  4. Under Advanced settings → Secrets, add whichever keys you use:
    GROQ_API_KEY   = "your_groq_api_key_here"
    GEMINI_API_KEY = "your_gemini_api_key_here"
  5. Click Deploy — you get a shareable public URL

The API key is injected as an environment secret on the server. Users never see it.


🔒 Security & Privacy

What Where
API key Server-side only (.env locally, Streamlit Secrets in cloud)
Your PDF In-memory session only — never written to disk
Extracted text Streamlit session state, cleared on tab close
AI results Displayed on screen, not persisted anywhere

The API key is never exposed to the browser or user. Groq's free tier does not persistently store conversation data.


🗂️ Project Structure

studyai/
├── app.py              # Main Streamlit application
├── requirements.txt    # Python dependencies
├── .env.example        # API key template (safe to commit)
├── .gitignore          # Keeps .env and secrets out of GitHub
└── README.md

🧰 Tech Stack

Component Tool
UI Streamlit
PDF Extraction PyMuPDF (fitz)
AI Inference Groq API (Llama 3, Mixtral, Gemma)
Session Storage Streamlit Session State
Deployment Streamlit Community Cloud
Language Python 3.10+

🛣️ Roadmap

  • Chat, PDF chat, Summarizer, Quiz, Flashcards
  • Concept Explainer, Essay Helper, Problem Solver
  • Translate & Learn, Study Planner
  • Server-side API key (never exposed to users)
  • Download results as PDF / DOCX
  • PPTX and DOCX upload support
  • Offline mode via Ollama
  • Multi-language UI (Urdu, Arabic)

Built as a free, open-source tool for students. No ads, no subscriptions, no data collection.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages