{"id":28051518,"url":"https://github.com/dagmawi-22/qelem-web","last_synced_at":"2025-05-12T01:54:52.970Z","repository":{"id":291542105,"uuid":"968169850","full_name":"Dagmawi-22/qelem-web","owner":"Dagmawi-22","description":"Client side AI-powered study tool that processes PDFs to generate quizzes and flashcards using Gemini AI.","archived":false,"fork":false,"pushed_at":"2025-05-07T18:46:44.000Z","size":256,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-12T01:54:48.576Z","etag":null,"topics":["ai","pdf-processing","question-answering","svelte","sveltekit"],"latest_commit_sha":null,"homepage":"https://qelem-web.vercel.app","language":"Svelte","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/Dagmawi-22.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-04-17T16:11:46.000Z","updated_at":"2025-05-07T18:46:48.000Z","dependencies_parsed_at":"2025-05-05T09:35:10.043Z","dependency_job_id":"774992e6-f947-4e8d-a929-8f76d2b1aeab","html_url":"https://github.com/Dagmawi-22/qelem-web","commit_stats":null,"previous_names":["dagmawi-22/qelem-web"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dagmawi-22%2Fqelem-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dagmawi-22%2Fqelem-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dagmawi-22%2Fqelem-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dagmawi-22%2Fqelem-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dagmawi-22","download_url":"https://codeload.github.com/Dagmawi-22/qelem-web/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253660837,"owners_count":21943823,"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","pdf-processing","question-answering","svelte","sveltekit"],"created_at":"2025-05-12T01:54:52.301Z","updated_at":"2025-05-12T01:54:52.961Z","avatar_url":"https://github.com/Dagmawi-22.png","language":"Svelte","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qelem \n![SvelteKit](https://img.shields.io/badge/SvelteKit-FF3E00?style=flat\u0026logo=svelte\u0026logoColor=white)\n![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=flat\u0026logo=typescript\u0026logoColor=white)\n\nA SvelteKit app that converts static PDFs into:\n- Interactive quizzes ✏️\n- Customizable exams 📝\n- Anki-compatible flashcard decks 🗂️\n- Structured study guides 📚\n\n**Backend Companion**: [qelem-api](https://github.com/Dagmawi-22/qelem-web-api) (NestJs + PgSql)\n\n## Table of Contents\n- [Features](#-features)\n- [Installation](#-installation)\n- [Contributing](#-contributing)\n- [License](#-license)\n\n## Features\n\n### PDF Processing\n##### \n- The user uploads a PDF document containing learning material.\n\n- Input Parameters\n    The user specifies:\n\n- Maximum number of questions desired\n\n- Difficulty level (easy, medium, or hard)\n\n- Content type: flashcards or exam\n\n- Content Extraction\n The system extracts raw text from the PDF.\n\n- Content Generation via Gemini API\nThe extracted content is sent to the Gemini API to generate either:\n\n A deck of flashcards, or\n\n A structured set of exam questions\n\n Output Formatting \u0026 Saving\n The generated content is formatted in a predefined structure and saved as a JSON file.\n\n Download/Return Result\n The final output file is returned to the user for access.\n\n### Social Sharing\n##### \n- The user generates the desired learning content (exam or deck of cards).\n\n- The user selects a social platform to share to from frontend or copy the content link \u0026 shares it to others.\n\n- Api will return the specific content parsing it from the shared url.\n\n### To be added:\n   - Adding popular pdf materials\n   - Progress tracking for a user\n   - Study scheduler \u0026 with notifications\n   - Personalization of learning content \u0026 studying user behaviour\n\n## ⚙️ Installation (Docker)\n ### Clone the repository\n```bash\n     git clone https://github.com/Dagmawi-22/qelem-web.git ```\n     cd qelem-web\n```\n ### Create a .env file if it doesn't exist based on .env.example:\n```bash\n    VITE_API_BASE_URL=http://localhost:8000/api/v1\n```\n ### Start the application with Docker:\n```bash\n    docker-compose up --build\n```\n\n### 🤝 Contributing\n##### Contributions are welcome! If you have ideas for improvements, bug fixes, or new features, feel free to fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you’d like to add.\n\n### 🔒 License\n##### Do whatever you want with it — learn from it, build on it, break it, remix it. Just don’t be shady. A little credit is always appreciated. ✌️\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdagmawi-22%2Fqelem-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdagmawi-22%2Fqelem-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdagmawi-22%2Fqelem-web/lists"}