EduStream - Adaptive Streaming Platform for Education

EduStream is a cloud-native adaptive streaming platform optimized for low-bandwidth environments (100 kbps–1.5 Mbps). It enables educators to deliver high-quality video content to students in regions with limited connectivity.

🎯 Features

Adaptive Bitrate Streaming: Automatic quality adjustment based on bandwidth
Offline Content Caching: PWA support for offline viewing
Low-Bandwidth Optimization: Works reliably on 100 kbps–1.5 Mbps connections
Encoding Pipeline: Automated FFmpeg-based video encoding (multiple quality levels)
Message Queue: RabbitMQ for async encoding jobs
Real-time Monitoring: Prometheus + Grafana dashboards
Distributed Tracing: Jaeger for observability
Microservices Architecture: Modular, scalable design
Secure Authentication: JWT-based auth with role-based access control

🏗️ Architecture

EduStream (Monorepo)
├── apps/
│   ├── backend/          # NestJS microservices
│   │   ├── src/
│   │   │   ├── auth/     # JWT authentication
│   │   │   ├── users/    # User management
│   │   │   ├── content/  # Video content metadata
│   │   │   ├── streaming/ # HLS delivery service
│   │   │   ├── encoding/ # FFmpeg worker service
│   │   │   └── analytics/ # Usage analytics
│   │   └── package.json
│   └── frontend/         # React + Tailwind frontend
│       ├── src/
│       │   ├── components/
│       │   ├── pages/
│       │   ├── services/
│       │   └── hooks/
│       └── package.json
├── infra/                # Infrastructure configs
│   ├── docker/
│   ├── kubernetes/
│   ├── terraform/
│   └── cicd/
├── docker-compose.yml    # Local development stack
└── README.md

🚀 Quick Start

Prerequisites

Node.js >= 18
Docker & Docker Compose
Git

1. Clone & Setup

cd edustream
npm install

2. Environment Configuration

cp .env.example .env
# Update .env with your configuration if needed

3. Start Development Stack

npm run docker:up

This will start:

MongoDB (27017): Database
Redis (6379): Cache & session store
RabbitMQ (5672, 15672): Message broker
FFmpeg Service: Encoding worker
Prometheus (9090): Metrics
Grafana (3003): Dashboards
Jaeger (16686): Distributed tracing
MinIO (9000, 9001): S3-compatible storage

4. Start Backend & Frontend

# In separate terminals:
npm run dev:backend  # Runs on http://localhost:3000
npm run dev:frontend # Runs on http://localhost:3001

Or all at once:

npm run dev

5. Verify Services

Backend: http://localhost:3000/api/health
Frontend: http://localhost:3001
RabbitMQ Management: http://localhost:15672 (guest/guest)
Grafana: http://localhost:3003 (admin/admin)
Jaeger: http://localhost:16686
MinIO: http://localhost:9001 (minioadmin/minioadmin)

📦 Project Workspace

edustream/
├── apps/backend/          # NestJS backend
│   ├── src/
│   │   ├── main.ts
│   │   ├── app.module.ts
│   │   └── ... (modules to be created)
│   ├── package.json
│   └── tsconfig.json
├── apps/frontend/         # React frontend
│   ├── src/
│   │   ├── index.tsx
│   │   └── ... (components to be created)
│   ├── package.json
│   └── tsconfig.json
├── infra/
│   ├── docker-compose.yml
│   ├── Dockerfile.ffmpeg
│   ├── mongodb/init.js
│   ├── prometheus/prometheus.yml
│   └── kubernetes/ (manifests)
├── docker-compose.yml
├── package.json (root)
└── .env.example

🛠️ Development Commands

Backend

cd apps/backend
npm run start:dev     # Start with hot-reload
npm run build         # Build for production
npm run test          # Run unit tests
npm run test:e2e      # Run integration tests

Frontend

cd apps/frontend
npm start             # Start dev server
npm run build         # Build for production
npm run test          # Run tests
npm run eject         # Eject from CRA (one-way)

Docker

npm run docker:build  # Build all services
npm run docker:up     # Start containers
npm run docker:down   # Stop containers
npm run docker:logs   # View logs

🧪 Testing

Unit & Integration Tests

npm run test          # Run all tests
npm run test:backend  # Backend tests only
npm run test:frontend # Frontend tests only

Coverage

npm run test -- --coverage

📊 Monitoring & Observability

Metrics (Prometheus)

http://localhost:9090
Queries available for uptime, request latency, encoding jobs, etc.

Dashboards (Grafana)

http://localhost:3003
Pre-configured dashboards for API health, video encoding, and streaming quality

Distributed Tracing (Jaeger)

http://localhost:16686
Trace requests across microservices

🔐 Security

JWT Authentication: All API endpoints protected
Password Hashing: bcryptjs with salt rounds = 10
Rate Limiting: 100 requests per 15 minutes
CORS: Configured for localhost:3000 and localhost:3001
Environment Secrets: Use .env file, never commit secrets

📝 Next Steps

Phase 2: Core Backend

Initialize NestJS app with database setup
Create MongoDB schemas (users, videos, encodings)
Set up Redis client and caching layer

Phase 3: Authentication

JWT auth service
User registration & login endpoints
Role-based access control (RBAC)

Phase 4: Streaming Service

HLS manifest generation
Adaptive bitrate selection
Progress tracking

Phase 5: Encoding Pipeline

FFmpeg worker service
RabbitMQ job queue
Quality level generation (240p, 360p, 480p, 720p)

Phase 6: Frontend

React setup with Tailwind CSS
HLS.js video player
Offline PWA caching
User dashboard

Phase 7: Infrastructure

Kubernetes manifests
Terraform configs (AWS/GCP/Azure)
Helm charts

Phase 8: CI/CD

GitHub Actions workflows
Automated testing on push
Docker image building & registry push
Automated deployment

📚 Documentation

See /docs (to be created) for:

API specifications (Swagger)
Database schemas
Encoding quality guidelines
Deployment guides
Troubleshooting

🤝 Contributing

Create a feature branch: git checkout -b feature/your-feature
Commit changes: git commit -m 'Add feature'
Push: git push origin feature/your-feature
Create a Pull Request

📄 License

MIT License - See LICENSE file

📞 Support

For issues or questions:

Open an issue on GitHub
Check existing documentation
Review logs: npm run docker:logs

Built with ❤️ for educators and students worldwide.

Name		Name	Last commit message	Last commit date
apps		apps
infra		infra
.env.example		.env.example
.gitignore		.gitignore
API_DOCUMENTATION.md		API_DOCUMENTATION.md
PHASE1_COMPLETE.md		PHASE1_COMPLETE.md
PROJECT_COMPLETE.md		PROJECT_COMPLETE.md
QUICK_START.md		QUICK_START.md
README.md		README.md
ROADMAP.md		ROADMAP.md
SETUP_COMPLETE.md		SETUP_COMPLETE.md
START_HERE.md		START_HERE.md
docker-compose.yml		docker-compose.yml
package.json		package.json
project-tree.ps1		project-tree.ps1
verify-setup.sh		verify-setup.sh

Latest commit

History

Folders and files

Repository files navigation