AI-powered study aid generator that transforms syllabus content into comprehensive, interactive study materials
Syllabyte is an advanced educational tool designed to revolutionize how students study. By leveraging AI technology, it converts syllabus content and academic topics into a variety of engaging study formats including detailed notes, formula compilations, interactive mind maps, and self-assessment quizzes.
- Intelligent Notes: Automatically generated study notes with full markdown support
- Formula Extraction: Smart identification and formatting of mathematical formulas
- Interactive Mind Maps: Visual concept mapping powered by GoJS
- Self-Assessment: Auto-generated MCQs with detailed explanations
- Document Support: Upload and process syllabi in PDF and DOCX formats
- Secure account registration and authentication
- Personal study material library
- Search history tracking and management
- Comprehensive user profiles
- Professional dark theme with neon accents
- Fully responsive design for all devices
- Animated transitions and backgrounds
- Interactive data visualizations
- Python 3.8+
- pip
- Virtual environment tool (recommended)
- Clone the repository
git clone https://github.com/yourusername/syllabyte.git
cd syllabyte- Set up a virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate- Install dependencies
pip install -r requirements.txt- Configure environment variables
cp .env.example .env
# Edit .env file and add your Groq API key- Initialize the database
flask db upgrade- Run the application
flask runEssential configuration options in the .env file:
GROQ_API_KEY=gsk_your_key_here
FLASK_SECRET_KEY=your_secret_key
DATABASE_URL=sqlite:///history.db
- HTML5 / CSS3
- JavaScript
- GoJS (mind mapping)
- MathJax (math rendering)
- Marked.js (markdown parsing)
- Python
- Flask web framework
- SQLAlchemy ORM
- Groq LLM API
- SQLite database
POST /register- Create new user accountPOST /login- Authenticate existing userGET /logout- End current user session
POST /index- Generate study materials from a topicPOST /upload_document- Process uploaded syllabus documentsGET /get_history_content/<history_id>- Retrieve saved study materials
Syllabyte implements several security measures:
- Secure API key management via environment variables
- Password hashing before storage
- Session-based authentication
- Input validation and sanitization
- Cross-Site Request Forgery (CSRF) protection
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- The Groq team for their powerful LLM API
- GoJS for mind mapping capabilities
- MathJax for beautiful math rendering
Crafted with 🧠 by the Syllabyte Team – Revolutionizing the way students study with AI.