Skip to content

Commit 049c0ee

Browse files
committed
UPDATED README
1 parent 9eab43b commit 049c0ee

File tree

1 file changed

+43
-61
lines changed

1 file changed

+43
-61
lines changed

README.md

Lines changed: 43 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -33,42 +33,25 @@ Instructify isn't just another video conferencing tool - it's a **next-generatio
3333
- 🛡️ **AI Spam Filtering** - Advanced content moderation with context awareness
3434
- 💬 **Context-Aware Responses** - AI understands lecture content for relevant answers
3535

36-
### 🚀 **Mind-Blowing Features**
37-
38-
<table>
39-
<tr>
40-
<td width="50%">
41-
42-
#### 🎥 **Live Video Streaming**
43-
- **WebRTC-powered** low-latency streaming
44-
- Teacher-to-students broadcast
45-
- HD video quality with audio
46-
- Screen sharing capabilities
47-
48-
#### 💬 **Intelligent Chat System**
49-
- **Real-time messaging** with WebSockets
50-
- **Dual-mode chat**: Public + AI assistant
51-
- **Smart routing** of student queries
52-
- **Teacher notifications** for important doubts
53-
54-
</td>
55-
<td width="50%">
56-
57-
#### 📊 **Analytics & Insights**
58-
- **Engagement tracking** and participation metrics
59-
- **Real-time attendance** via WebRTC connections
60-
- **Learning analytics** dashboard
61-
- **Performance insights** for educators
62-
63-
#### 🎨 **Modern UI/UX**
64-
- **Responsive design** with Tailwind CSS
65-
- **Dark/Light themes** support
66-
- **Intuitive navigation** for all user types
67-
- **Mobile-friendly** interface
68-
69-
</td>
70-
</tr>
71-
</table>
36+
### Core Features
37+
38+
#### Real-time Communication
39+
- **WebRTC Video Streaming**: Low-latency teacher-to-students broadcasting
40+
- **Live Chat System**: Real-time messaging with WebSocket technology
41+
- **Screen Sharing**: High-quality screen capture and streaming
42+
- **Cross-platform Support**: Compatible with modern web browsers
43+
44+
#### AI-Powered Learning
45+
- **Intelligent Content Filtering**: Dual-layer protection using keywords and AI analysis
46+
- **Smart Doubt Classification**: Automatic detection of genuine academic questions
47+
- **Context-aware AI Assistant**: Educational responses based on lecture content
48+
- **Real-time Moderation**: Instant filtering of inappropriate content
49+
50+
#### User Experience
51+
- **Professional Interface**: Clean, intuitive design for both teachers and students
52+
- **Responsive Design**: Optimized for desktop and mobile devices
53+
- **Role-based Access**: Separate interfaces for teachers and students
54+
- **Easy Setup**: Simple classroom creation and joining process
7255

7356
---
7457

@@ -135,7 +118,7 @@ cd Instructify
135118
```bash
136119
cd backend
137120
uv add fastapi "uvicorn[standard]" websockets python-socketio pydantic langchain langgraph google-generativeai httpx
138-
uv run python -m app.main
121+
uv run uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
139122
```
140123
> 🚀 **Backend running on**: http://localhost:8000
141124
@@ -289,32 +272,31 @@ const notes = await getGeneratedNotes(classId);
289272

290273
---
291274

292-
## 🌈 **Roadmap & Future Features**
275+
## Development Roadmap
293276

294-
<div align="center">
295-
296-
### 🎯 **Phase 1 - COMPLETED**
297-
- [x] Core FastAPI + Next.js infrastructure
298-
- [x] Real-time WebSocket communication
299-
- [x] AI assistant with Gemma 270M
300-
- [x] Smart doubt classification
277+
### Phase 1 - Core Platform (Completed)
278+
- [x] FastAPI backend with WebSocket support
279+
- [x] Next.js 15 frontend with TypeScript
280+
- [x] Real-time video streaming via WebRTC
281+
- [x] AI-powered content filtering with Gemini 2.5 Flash Lite
282+
- [x] Intelligent chat system with dual-layer moderation
301283
- [x] Teacher/Student role management
302-
303-
### 🚧 **Phase 2 - IN PROGRESS** 🔄
304-
- [ ] WebRTC video streaming implementation
305-
- [ ] Gemini 2.5 Flash Lite transcription
306-
- [ ] Advanced spam filtering with LangGraph
307-
- [ ] Auto-generated notes from transcripts
308-
309-
### 🔮 **Phase 3 - PLANNED** 📅
310-
- [ ] Interactive whiteboard with AI annotations
311-
- [ ] Virtual breakout rooms with AI moderation
312-
- [ ] Multi-language support (50+ languages)
313-
- [ ] Advanced analytics & learning insights
314-
- [ ] Mobile app (React Native)
315-
- [ ] Blockchain-based certificates
316-
317-
</div>
284+
- [x] Cross-browser compatibility
285+
286+
### Phase 2 - Enhanced Features (In Progress)
287+
- [ ] Voice transcription and live captions
288+
- [ ] Automated class notes generation
289+
- [ ] Advanced analytics dashboard
290+
- [ ] Enhanced mobile responsiveness
291+
- [ ] Performance optimization
292+
293+
### Phase 3 - Advanced Capabilities (Planned)
294+
- [ ] Interactive whiteboard collaboration
295+
- [ ] Breakout room functionality
296+
- [ ] Multi-language support
297+
- [ ] Learning analytics and insights
298+
- [ ] Mobile application (React Native)
299+
- [ ] Integration with LMS platforms
318300

319301
---
320302

0 commit comments

Comments
 (0)