syncmaster6 / README.md
aseelflihan's picture
Initial commit without node_modules
6123728
---
title: SyncMaster Enhanced
emoji: ๐Ÿš€
colorFrom: red
colorTo: red
sdk: docker
app_port: 8501
tags:
- streamlit
- ai-translation
- speech-to-text
- multilingual
- education
pinned: false
short_description: AI-powered audio transcription
license: mit
---
# SyncMaster Enhanced - AI-Powered Audio Transcription & Translation
> **๐ŸŒŸ New: Enhanced with AI Translation Support for International Students**
> **ุฌุฏูŠุฏ: ู…ุญุณู† ู…ุน ุฏุนู… ุงู„ุชุฑุฌู…ุฉ ุจุงู„ุฐูƒุงุก ุงู„ุงุตุทู†ุงุนูŠ ู„ู„ุทู„ุงุจ ุงู„ุฏูˆู„ูŠูŠู†**
SyncMaster is an intelligent audio-text synchronization platform specifically designed for international students in universities. It provides real-time audio recording, AI-powered transcription, and automatic translation to help students better understand and review their lectures.
## โœจ Key Features
### ๐ŸŒ Multi-Language Support
- **Full Arabic Interface**: Complete Arabic UI for better accessibility
- **AI-Powered Translation**: Automatic translation to Arabic, English, French, and Spanish
- **Language Detection**: Automatically detects the source language
- **Academic Context**: Specialized translation for academic content
### ๐ŸŽ™๏ธ Enhanced Recording
- **Browser-based Recording**: Record directly from your web browser
- **Real-time Audio Visualization**: Visual feedback during recording
- **Important Markers**: Mark important points during lectures
- **Pause/Resume**: Full control over recording sessions
### ๐Ÿค– AI Technology
- **Gemini AI Integration**: Accurate transcription using Google's Gemini AI
- **Advanced Translation**: Context-aware translation for educational content
- **Parallel Processing**: Fast and efficient audio processing
### ๐Ÿ“ฑ Student-Friendly Features
- **Responsive Design**: Works on desktop, tablet, and mobile
- **Keyboard Shortcuts**: Quick access to common functions
- **Accessibility**: Screen reader support and RTL language support
- **Offline Capability**: Process recordings without constant internet
## ๐Ÿš€ Quick Start
### For International Students:
1. **Setup**:
```bash
# Clone or download the project
# Install Python 3.8+
python setup_enhanced.py
```
2. **Run**:
```bash
# Windows
start_enhanced.bat
# Linux/Mac
python setup_enhanced.py
```
3. **Configure**:
- Add your Gemini API key to `.env` file
- Choose your preferred language (Arabic/English)
- Enable translation and select target language
### API Key Setup:
1. Get a free Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey)
2. Add it to your `.env` file:
```
GEMINI_API_KEY=your_api_key_here
```
## ๐Ÿ“– Usage Guide
### Recording Lectures:
1. Go to the **Record Audio** tab
2. Click **Start Recording**
3. Use **Mark Important** for key points
4. Click **Stop** when finished
5. Click **Extract Text** to process
### Translation:
1. Enable translation in settings
2. Select target language
3. Process your audio
4. Review both original and translated text
### Export Options:
- Copy text for notes
- Save as files for later review
- Generate synchronized videos (coming soon)
## ๐ŸŽ“ For Students
### Arabic Students (ู„ู„ุทู„ุงุจ ุงู„ุนุฑุจ):
- ุงุณุชุฎุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุนุฑุจูŠุฉ ู„ุณู‡ูˆู„ุฉ ุงู„ุงุณุชุฎุฏุงู…
- ูุนู‘ู„ ุงู„ุชุฑุฌู…ุฉ ู„ู„ุฅู†ุฌู„ูŠุฒูŠุฉ ู„ูู‡ู… ุงู„ู…ุตุทู„ุญุงุช ุงู„ุชู‚ู†ูŠุฉ
- ุถุน ุนู„ุงู…ุงุช ุนู„ู‰ ุงู„ู…ูุงู‡ูŠู… ุงู„ุฌุฏูŠุฏุฉ ุฃุซู†ุงุก ุงู„ู…ุญุงุถุฑุฉ
### International Students:
- Use translation to your native language for better understanding
- Mark important concepts during lectures
- Review both original and translated text together
## โŒจ๏ธ Keyboard Shortcuts
- **Space**: Start/Stop recording
- **M**: Mark important point
- **P**: Pause/Resume
- **R**: Re-record
## ๐Ÿ”ง Technical Requirements
### System Requirements:
- Python 3.8 or higher
- Modern web browser (Chrome, Firefox, Safari, Edge)
- Microphone access for recording
- Internet connection for AI processing
### Dependencies:
- Streamlit (Web interface)
- Google Generative AI (Transcription & Translation)
- Flask (Recording server)
- LibROSA (Audio processing)
## ๐Ÿ“ฑ Browser Compatibility
| Browser | Recording | Translation | UI |
|---------|-----------|-------------|----|
| Chrome | โœ… | โœ… | โœ… |
| Firefox | โœ… | โœ… | โœ… |
| Safari | โœ… | โœ… | โœ… |
| Edge | โœ… | โœ… | โœ… |
## ๐Ÿ› ๏ธ Troubleshooting
### Common Issues:
**Microphone not working:**
- Grant microphone permission to your browser
- Check system audio settings
- Try a different browser
**Translation errors:**
- Check internet connection
- Verify Gemini API key
- Try processing again
**Poor transcription quality:**
- Ensure clear audio recording
- Reduce background noise
- Speak clearly and at moderate pace
## ๐Ÿ”ฎ Roadmap
### Coming Soon:
- **Smart Content Analysis**: Automatic extraction of key concepts
- **Study Cards**: Generate flashcards from lectures
- **Platform Integration**: Connect with Moodle, Canvas, etc.
- **Collaborative Features**: Share recordings with classmates
- **Advanced Analytics**: Learning progress tracking
## ๐Ÿ“š Documentation
- [**Arabic Guide**](README_AR.md) - ุฏู„ูŠู„ ุจุงู„ู„ุบุฉ ุงู„ุนุฑุจูŠุฉ
- [**API Documentation**](docs/api.md) - Technical API reference
- [**Troubleshooting**](docs/troubleshooting.md) - Detailed problem solving
## ๐Ÿค Contributing
We welcome contributions from the international student community:
1. Fork the repository
2. Create a feature branch
3. Add your improvements
4. Submit a pull request
### Areas for Contribution:
- Additional language support
- UI improvements
- Mobile optimization
- Documentation translation
## ๐Ÿ“„ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## ๐Ÿ™ Acknowledgments
- Google Gemini AI for transcription and translation
- Streamlit team for the amazing web framework
- International student community for feedback and testing
## ๐Ÿ“ž Support
For technical support or questions:
- Check the browser console (F12) for error details
- Review log files in the application directory
- Ensure all dependencies are up to date
---
**Made with โค๏ธ for international students worldwide**
**ุตูู†ุน ุจู€ โค๏ธ ู„ู„ุทู„ุงุจ ุงู„ุฏูˆู„ูŠูŠู† ุญูˆู„ ุงู„ุนุงู„ู…**
---
### Quick Links:
- ๐Ÿš€ [Quick Start Guide](docs/quickstart.md)
- ๐ŸŒ [Arabic Documentation](README_AR.md)
- ๐ŸŽ“ [Student Guide](docs/student-guide.md)
- ๐Ÿ”ง [Technical Setup](docs/technical-setup.md)