An open API service indexing awesome lists of open source software.

https://github.com/gbowne1/codestream

This is the code for a live streaming platform for programmers
https://github.com/gbowne1/codestream

coding development livestream platform programing streaming

Last synced: about 1 month ago
JSON representation

This is the code for a live streaming platform for programmers

Awesome Lists containing this project

README

          

# πŸ“Ί CodeStream (Prototype)

CodeStream (initially named **DevStream**) is a **Full-Stack Web Application** designed as a **live streaming platform specifically for developers**.

This project currently represents a **functional Proof of Concept (PoC)** featuring a complete **Authentication system**, a **modern responsive UI with Dark Mode**, and a **mock streaming API**.

> ⚠️ **Note:** This project is fully open source and aims to be a **unique platform**, not a clone. It is actively under development.

---

## 🎯 Target Audience

CodeStream is built for technical creators and learners, including:

- Game Developers
- Software Developers
- OS Developers
- Web Developers
- Mobile App Developers
- Cybersecurity & Ethical Hacking
- Game Artists & Pixel Artists
- LeetCode & Co‑working Streams
- Tech Talks & Conferences

---

## ✨ Current Features

### βœ… Implemented & Working

- πŸ” **Authentication System**
Secure Register & Login flow using **JWT** and **Bcrypt**.

- 🎨 **Modern UI**
Built with **Vanilla JavaScript** and **Bootstrap 5**, including **Dark/Light Mode toggle**.

- πŸ“± **Responsive Design**
Mobile‑first layout with a collapsible **Category Drawer**.

- πŸ” **Search & Filter**
Real‑time client‑side filtering using tags and search terms.

- πŸ“‘ **Mock Streaming API**
Express backend serving simulated stream data from `streams.json`.

---

## 🚧 Roadmap (Upcoming)

- πŸ”„ **WebSocket Integration** – Replace mock API with real‑time socket connections
- πŸŽ₯ **Video Broadcasting** – Implement **WebRTC** for real video streaming
- πŸ‘€ **User Profiles** – Upload avatars, update bios, and customize profiles

---

## πŸ› οΈ Tech Stack

### Frontend

- JavaScript (ES6 Modules)
- Bootstrap 5.3
- Vite

### Backend

- Node.js
- Express
- MongoDB (Mongoose)
- JWT Authentication
- Bcrypt Password Hashing

---

## πŸš€ Installation & Setup

Detailed developer setup instructions are maintained in the repository docs:

- **Developer setup guide**: `docs/DEVSETUP.md` β€” contains step-by-step instructions to run the backend, frontend, database, environment variables, linting, and troubleshooting.

---

## πŸ“‚ Project Structure

```
β”œβ”€β”€ src/
β”‚ β”œβ”€β”€ controllers/ # Auth logic (Register/Login)
β”‚ β”œβ”€β”€ middleware/ # JWT verification & role checks
β”‚ β”œβ”€β”€ models/ # Mongoose schemas
β”‚ β”œβ”€β”€ css/ # Global styles & dark mode
β”‚ └── js/ # Frontend DOM logic
β”œβ”€β”€ server.js # Express API entry point
β”œβ”€β”€ streams.json # Mock stream data
β”œβ”€β”€ vite.config.js # Vite configuration
└── package.json # Scripts & dependencies
```

---

## 🀝 Contributing

Contributions are welcome! πŸš€

1. Fork the project
2. Create your branch

```bash
git checkout -b feature/AmazingFeature
```

3. Commit your changes

```bash
git commit -m "Add AmazingFeature"
```

4. Push to GitHub

```bash
git push origin feature/AmazingFeature
```

5. Open a Pull Request

---

## πŸ“„ License

This project is licensed under the **MIT License**.

---

⭐ If you like this project, give it a star and help grow CodeStream!