https://github.com/arshcypherz/clarityhub
There are 3 branches (AI Backend, Frontend and AI Tutor)
https://github.com/arshcypherz/clarityhub
Last synced: 2 months ago
JSON representation
There are 3 branches (AI Backend, Frontend and AI Tutor)
- Host: GitHub
- URL: https://github.com/arshcypherz/clarityhub
- Owner: ArshCypherZ
- License: mit
- Created: 2025-04-12T17:16:26.000Z (6 months ago)
- Default Branch: ai-backend
- Last Pushed: 2025-07-30T10:14:48.000Z (3 months ago)
- Last Synced: 2025-07-30T12:45:37.369Z (3 months ago)
- Language: Python
- Homepage: https://clarityhub.duckdns.org
- Size: 2.41 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ClarityHub - AI-Powered Learning Platform
An intelligent learning platform that leverages AI to generate personalized study roadmaps, interactive quizzes, and comprehensive study materials. This platform aims to revolutionize the way students approach their academic journey.
## 🌟 Features
### 1. AI-Generated Study Roadmaps
- Personalized learning paths based on your subject and topic
- Customizable difficulty levels and timelines
- Progress tracking for each subtopic
- Adaptive to your prior knowledge level
### 2. Interactive Quizzes
- AI-generated questions to test your understanding
- Real-time feedback and explanations
- Progress tracking and performance analytics
- Personalized question difficulty based on your performance
### 3. Study Materials
- Comprehensive topic explanations
- Curated learning resources
- YouTube video recommendations
- Personalized content based on your learning style
## 🛠️ Getting Started
### Installation
1. Clone the repository
```bash
git clone reponame
cd reponame
```
2. Install dependencies
```bash
pip3 install -r requirements.txt
```
3. Set up environment variables
Create a `.env` file in the root directory or rename `sample.env` to `.env` and add the following:
```env
GEMINI_API_KEY=yourgeminiapikey
YOUTUBE_API_KEY=youtubeapikey from google cloud console
```
4. Start the development server
```bash
python3 main.py
```
Open [http://localhost:7070/docs](http://localhost:7070/docs) with your browser to see the API docs.
## 🎯 Usage
1. **Create a Study Roadmap**
- Enter your study topic/syllabus
- Specify subject, course level, and exam
- Choose difficulty level and timeline
- Get a personalized learning path
2. **Access Study Materials**
- Click on any subtopic in your roadmap
- View comprehensive explanations
- Access curated resources and videos
3. **Take Quizzes**
- Generate topic-specific quizzes
- Answer questions and get instant feedback
- Track your progress
## 🤝 Contributing
Contributions are welcome! Please feel free to submit issues and pull requests.
---
Built with ❤️