{"id":44507279,"url":"https://github.com/li147852xu/studyflow-ai","last_synced_at":"2026-02-13T11:03:00.833Z","repository":{"id":333875454,"uuid":"1139064628","full_name":"li147852xu/studyflow-ai","owner":"li147852xu","description":"StudyFlow-AI is a local-first research \u0026 coursework workspace that turns PDFs into citable notes, paper reviews, and presentation decks—with hybrid search, versioned outputs, and exportable submission packs.","archived":false,"fork":false,"pushed_at":"2026-01-29T15:52:43.000Z","size":611,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-30T02:41:57.902Z","etag":null,"topics":["fastapi","local-first","paper","rag","research","streamlit","zotero"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/li147852xu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-21T13:30:02.000Z","updated_at":"2026-01-29T15:52:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/li147852xu/studyflow-ai","commit_stats":null,"previous_names":["li147852xu/studyflow-ai"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/li147852xu/studyflow-ai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/li147852xu%2Fstudyflow-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/li147852xu%2Fstudyflow-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/li147852xu%2Fstudyflow-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/li147852xu%2Fstudyflow-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/li147852xu","download_url":"https://codeload.github.com/li147852xu/studyflow-ai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/li147852xu%2Fstudyflow-ai/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29403269,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","local-first","paper","rag","research","streamlit","zotero"],"created_at":"2026-02-13T11:03:00.045Z","updated_at":"2026-02-13T11:03:00.820Z","avatar_url":"https://github.com/li147852xu.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StudyFlow v3\n\n**A local-first Course \u0026 Research Operating System with coverage-audited RAG for comprehensive academic workflows.**\n\n---\n\n## Quick Start\n\n### Docker (Recommended)\n\n```bash\n# 1) Clone\ngit clone https://github.com/li147852xu/studyflow-ai.git\ncd studyflow-ai\n\n# 2) Set your LLM environment\nexport STUDYFLOW_LLM_BASE_URL=https://api.openai.com/v1\nexport STUDYFLOW_LLM_API_KEY=sk-your-key\nexport STUDYFLOW_LLM_MODEL=gpt-4o-mini\n\n# 3) Start\ndocker compose up --build\n\n# 4) Open\n# UI: http://localhost:8501\n# API: http://localhost:8000 (optional)\n```\n\n### Local Install\n\n```bash\npip install -e .\nstreamlit run app/main.py\n```\n\n---\n\n## Core Features\n\n### Course Management\n- **Course Info**: name, code, instructor, semester, weekly schedule\n- **Lectures**: organize materials by lecture/date/topic\n- **Materials**: slides, notes, readings linked to lectures\n- **Assignments**: specs, analysis, due dates, status tracking\n- **Exam Tools**: generate exam blueprints with coverage reports\n\n### Research Platform\n- **Projects**: goals, scope, milestones\n- **Papers**: import, parse, generate paper cards (summary, contributions, pros/cons)\n- **Ideas**: AI-generated novelty points with multi-turn confirmation dialogue\n- **Experiments**: plans from confirmed ideas, run logs, progress tracking\n- **Decks**: presentation generation with citations and coverage\n\n### Timetable \u0026 Todos\n- Course schedules auto-populate dashboard\n- Custom events and tasks\n- Global todo list linked to courses/projects\n\n### AI Assistant\n- Scoped queries (per course or project)\n- Global queries with map-reduce coverage\n- Coverage reports showing which docs/lectures were included\n\n---\n\n## RAG Coverage System (v3 Core)\n\nStudyFlow v3 solves the \"full course/project coverage\" problem:\n\n1. **Index Assets**: Each document gets offline-generated summary (300-800 tokens), outline, and key entities\n2. **Query Classifier**: Detects local vs global queries\n3. **Map-Reduce**: For global queries, maps over all docs then reduces with coverage audit\n4. **Coverage Report**: Shows included docs, missing docs, per-lecture evidence counts\n5. **Token Budget**: Configurable limits (default: map ≤250 tokens/doc, reduce ≤600 tokens)\n\nWhen coverage is incomplete, UI shows actionable buttons: \"Rebuild Index\", \"Expand Scope\", \"Import Missing\".\n\n---\n\n## UI Structure\n\n| Screen | Purpose |\n|--------|---------|\n| **Dashboard** | Today's schedule, todos, recent activity, quick stats |\n| **Library** | Document repository (link to courses/projects) |\n| **Courses** | Course management with lectures, assignments, exams |\n| **Research** | Projects, papers, ideas, experiments, decks |\n| **AI Assistant** | Scoped Q\u0026A with coverage reports |\n| **Tools** | Tasks, diagnostics, activity history, exports, help |\n| **Settings** | LLM config, retrieval mode, theme, language |\n\n---\n\n## Configuration\n\n### Environment Variables\n\n```bash\n# Required for generation\nSTUDYFLOW_LLM_BASE_URL=https://api.openai.com/v1\nSTUDYFLOW_LLM_API_KEY=sk-your-key\nSTUDYFLOW_LLM_MODEL=gpt-4o-mini\n\n# Optional\nSTUDYFLOW_EMBED_MODEL=sentence-transformers/all-MiniLM-L6-v2\nSTUDYFLOW_OCR_MODE=off    # off | auto | on\nSTUDYFLOW_WORKSPACES_DIR=./workspaces\n```\n\n### Retrieval Modes\n\n| Mode | Description |\n|------|-------------|\n| **Vector** | Semantic search via embeddings |\n| **BM25** | Keyword-based lexical search |\n| **Hybrid** | Fused Vector + BM25 (best accuracy) |\n\n---\n\n## CLI Reference\n\n```bash\n# System health\nstudyflow doctor\nstudyflow doctor --deep\n\n# Workspace\nstudyflow workspace create \"My Project\"\nstudyflow workspace list\n\n# Documents\nstudyflow ingest --workspace \u003cid\u003e document.pdf\n\n# Index\nstudyflow index build --workspace \u003cid\u003e\nstudyflow index status --workspace \u003cid\u003e\n\n# Query\nstudyflow query --workspace \u003cid\u003e --mode hybrid \"your question\"\n\n# Migration (v2 → v3)\nstudyflow migrate\n```\n\n---\n\n## Verification\n\n```bash\npython scripts/verify_v3_release.py\npython -m compileall .\npytest -q\nruff check .\n```\n\n---\n\n## Troubleshooting\n\n| Problem | Solution |\n|---------|----------|\n| \"LLM not configured\" | Settings → enter Base URL, Model, API Key |\n| Generation disabled | Check dashboard setup status |\n| Coverage incomplete | Use \"Rebuild Index\" or \"Import Missing\" buttons |\n| Task failed | Tools → Tasks → Retry button |\n\n### Diagnostic Tools\n- **Doctor**: Tools → Diagnostics → Doctor\n- **Index Rebuild**: Tools → Diagnostics → Rebuild Index\n- **Task Center**: Tools → Tasks (view/retry/cancel)\n\n---\n\n## Privacy \u0026 Local-First\n\n- All data stays on your machine\n- No telemetry or usage tracking\n- API keys stored in session only\n- Exportable data bundles\n\n```\nworkspaces/\u003cworkspace-id\u003e/\n├── uploads/     # Imported documents\n├── index/       # Vector + BM25 indexes\n├── outputs/     # Generated content\n└── vault/       # Versioned assets\n```\n\n---\n\n## Development\n\n```bash\ngit clone https://github.com/li147852xu/studyflow-ai.git\ncd studyflow-ai\npip install -e \".[dev]\"\n\n# Lint\nruff check .\n\n# Test\npytest -q\n\n# Run\nstreamlit run app/main.py\n```\n\n---\n\n## License\n\nThis project is for educational and personal use.\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eStudyFlow v3.0.0\u003c/strong\u003e\u003cbr\u003e\n  Local-first Course \u0026 Research OS\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fli147852xu%2Fstudyflow-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fli147852xu%2Fstudyflow-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fli147852xu%2Fstudyflow-ai/lists"}