{"id":29472023,"url":"https://github.com/joemathew2004/study-buddy","last_synced_at":"2026-05-17T06:31:57.007Z","repository":{"id":303014308,"uuid":"1014140130","full_name":"joemathew2004/Study-Buddy","owner":"joemathew2004","description":"Study Buddy is a user-friendly AI-powered web app that helps students generate safe, factual study notes and Q\u0026A on any topic. It features user accounts, study history, and strong content safety filters—making learning interactive and secure.","archived":false,"fork":false,"pushed_at":"2025-07-05T06:34:42.000Z","size":3335,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-05T07:24:31.578Z","etag":null,"topics":["ai","chatbot","content-safety","education","flask","groq","learning","project","python","qna","study","webapp"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/joemathew2004.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}},"created_at":"2025-07-05T06:05:45.000Z","updated_at":"2025-07-05T06:42:46.000Z","dependencies_parsed_at":"2025-07-05T07:24:33.399Z","dependency_job_id":"2fc9a2e1-7083-4767-b6d6-bfce37813b19","html_url":"https://github.com/joemathew2004/Study-Buddy","commit_stats":null,"previous_names":["joemathew2004/study-buddy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/joemathew2004/Study-Buddy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joemathew2004%2FStudy-Buddy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joemathew2004%2FStudy-Buddy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joemathew2004%2FStudy-Buddy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joemathew2004%2FStudy-Buddy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joemathew2004","download_url":"https://codeload.github.com/joemathew2004/Study-Buddy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joemathew2004%2FStudy-Buddy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265305748,"owners_count":23743894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ai","chatbot","content-safety","education","flask","groq","learning","project","python","qna","study","webapp"],"created_at":"2025-07-14T14:33:43.402Z","updated_at":"2025-10-27T04:08:11.288Z","avatar_url":"https://github.com/joemathew2004.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Study Buddy\n\nAn AI-powered educational app that generates safe, factual study materials and Q\u0026A for any topic, with user accounts and history tracking.\n\n---\n\n## Images\n\nBelow are some screenshots of Study Buddy in action:\n\n![Home Page](images/Register.png)\n![Notes Generated](images/Notes%20Generation.png)\n![Q\u0026A Example](images/Q%20and%20A.png)\n\n---\n\n## Features\n\n- 🔐 User registration \u0026 login\n- 📚 AI-generated study notes and Q\u0026A\n- 📝 Study history tracking\n- 💡 Interesting facts for each topic\n- 🛡️ Content safety \u0026 inappropriate content blocking\n- ✅ Famous person validation\n- 🎨 Colorful, interactive UI\n\n---\n\n## Quick Start\n\n1. **Clone the repository:**\n   ```bash\n   git clone https://github.com/yourusername/study-buddy.git\n   cd study-buddy\n   ```\n\n2. **Install dependencies:**\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n3. **Set up environment variables:**\n   ```bash\n   cp .env.example .env\n   # Edit .env and add your GROQ API key\n   ```\n\n4. **Run the application:**\n   ```bash\n   # Start the backend server\n   python server.py\n   \n   # Start the frontend server (in another terminal)\n   python -m http.server 8000\n   ```\n\n5. **Open your browser:**\n   [http://localhost:8000/app.html](http://localhost:8000/app.html)\n\n---\n\n## Project Structure\n\n```\n├── app.html           # Main frontend HTML\n├── app.py             # (Optional) Additional backend logic\n├── check_db.py        # Script to inspect the database\n├── config.js          # Frontend API config\n├── config.py          # (Optional) Backend config\n├── index.html         # Landing page\n├── qa-styles.css      # Q\u0026A section styles\n├── requirements.txt   # Python dependencies\n├── script.js          # Main frontend JS\n├── server.py          # Flask backend\n├── study_buddy.db     # SQLite database (auto-created)\n├── style.css          # General styles\n└── ...\n```\n\n---\n\n## Usage\n\n1. Register or log in with your credentials\n2. Enter any educational topic in the search box\n3. Get AI-generated notes and Q\u0026A\n4. View your study history in the sidebar\n5. Enjoy interesting facts about your topics\n\n---\n\n## Safety Features\n\n- Blocks inappropriate content and bad language\n- Only allows famous historical figures and educational topics\n- Prevents saving failed or inappropriate queries to history\n- Shows helpful error messages with topic suggestions\n\n---\n\n## Technologies Used\n\n- **Backend:** Python, Flask, SQLite\n- **Frontend:** HTML, CSS, JavaScript\n- **AI:** Groq API (Llama 3)\n- **Styling:** Font Awesome, Google Fonts\n\n---\n\n## API Key\n\nYou need a GROQ API key to run this application. Get one from [Groq Console](https://console.groq.com/) and add it to your `.env` file.\n\n---\n\n## License\n\nThis project is for educational purposes only.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoemathew2004%2Fstudy-buddy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoemathew2004%2Fstudy-buddy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoemathew2004%2Fstudy-buddy/lists"}