https://github.com/sarvamm/brainbrew
AI powered study partner that can generate notes, qnas and quizes.
https://github.com/sarvamm/brainbrew
ai generative-ai langchain llms python streamlit
Last synced: about 2 months ago
JSON representation
AI powered study partner that can generate notes, qnas and quizes.
- Host: GitHub
- URL: https://github.com/sarvamm/brainbrew
- Owner: Sarvamm
- License: other
- Created: 2025-05-22T05:20:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-22T05:57:33.000Z (about 1 year ago)
- Last Synced: 2025-05-30T00:07:35.740Z (about 1 year ago)
- Topics: ai, generative-ai, langchain, llms, python, streamlit
- Language: Python
- Homepage: https://brain-brew.streamlit.app/
- Size: 92.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[BrainBrew]("https://brain-brew.streamlit.app/") is a Streamlit application that uses **AI** (Large Language Models) to help users learn.
It takes user-provided *topics* and an *API key* to generate **detailed notes**, **question/answer pairs**, and **interactive multiple-choice quizzes**.
The app manages user data and progress using *session state* across different features.
## Visual Overview
```mermaid
flowchart TD
A0["Streamlit Application Structure
"]
A1["Session State Management
"]
A2["LLM Communication Layer
"]
A3["Prompt Engineering
"]
A4["Structured Output Handling
"]
A5["Content Generation Pipelines (LangChain Chains)
"]
A6["Interactive Quiz Logic
"]
A7["User Configuration & Input
"]
A0 -- "Manages State" --> A1
A0 -- "Provides UI for Input" --> A7
A7 -- "Stores Configuration" --> A1
A7 -- "Supplies Topics" --> A5
A7 -- "Supplies API Key" --> A2
A5 -- "Interacts with LLM" --> A2
A5 -- "Applies Prompting" --> A3
A5 -- "Enforces Structure" --> A4
A5 -- "Saves Generated Content" --> A1
A5 -- "Generates Quiz Data for" --> A6
A6 -- "Updates Progress State" --> A1
```
## Chapters
1. [Streamlit Application Structure
](tutorial/01_streamlit_application_structure_.md)
2. [User Configuration & Input
](tutorial/02_user_configuration___input_.md)
3. [Session State Management
](tutorial/03_session_state_management_.md)
4. [LLM Communication Layer
](tutorial/04_llm_communication_layer_.md)
5. [Content Generation Pipelines (LangChain Chains)
](tutorial/05_content_generation_pipelines__langchain_chains__.md)
6. [Prompt Engineering
](tutorial/06_prompt_engineering_.md)
7. [Structured Output Handling
](tutorial/07_structured_output_handling_.md)
8. [Interactive Quiz Logic
](tutorial/08_interactive_quiz_logic_.md)
---