Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tobysolutions/stream2peer
This a free, decentralized video stream management service that is an open source version of StreamYard.
https://github.com/tobysolutions/stream2peer
decentralized hacktoberfest linkedin livepeer livestream open-source streaming twitch web3 youtube
Last synced: 2 months ago
JSON representation
This a free, decentralized video stream management service that is an open source version of StreamYard.
- Host: GitHub
- URL: https://github.com/tobysolutions/stream2peer
- Owner: tobySolutions
- License: mit
- Created: 2024-10-04T15:26:24.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T23:26:08.000Z (2 months ago)
- Last Synced: 2024-10-30T01:51:33.991Z (2 months ago)
- Topics: decentralized, hacktoberfest, linkedin, livepeer, livestream, open-source, streaming, twitch, web3, youtube
- Language: TypeScript
- Homepage:
- Size: 4.69 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stream2Peer
Stream2Peer is a decentralized video stream management platform built on top of [Livepeer](https://livepeer.org/). Inspired by [StreamYard](https://streamyard.com/), this project replicates the core functionalities of StreamYard with added advantages of decentralization, scalability, and enhanced user control. Stream2Peer allows users to broadcast, record, and manage live streams seamlessly using the power of Web3 and Livepeer's open-source technology.
## Code of Conduct
We are committed to fostering an open and welcoming environment. Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to understand the behavior we expect from our contributors and maintainers.
## Features
- **Decentralized Streaming**: Stream2Peer uses the Livepeer protocol to deliver highly scalable and decentralized video streaming services.
- **Multiple Streaming Destinations**: Broadcast to multiple platforms like YouTube, Twitch, LinkedIn, and more simultaneously.
- **Customizable Layouts**: Flexible layout options for live streaming, allowing you to control how guests and shared media appear.
- **Multi-Guest Support**: Invite guests easily to join your live streams with a simple URL.
- **Recording and Playback**: Record live streams and provide playback options for your audience.
- **Browser-Based Streaming**: No additional downloads required; Stream2Peer operates entirely from the browser.
- **Chat and Audience Interaction**: Built-in tools for live chat and audience engagement.
- **Monorepo Setup**: Organize both frontend and backend codebases in a single repository using `pnpm` workspaces.
## Tech Stack
- **Frontend**:
- Framework: [React](https://react.dev/) with [Vite](https://vitejs.dev/) for a fast development environment.
- UI: [TailwindCSS](https://tailwindcss.com/) for styling and flexibility in design.
- **Backend**:
- Framework: [AdonisJS](https://adonisjs.com/) for a scalable and robust server.
- Database: [MySQL](https://www.mysql.com/) (or any SQL database you prefer).
- **Streaming & Transcoding**:
- [Livepeer](https://livepeer.org/): Utilized for decentralized transcoding and media handling.
- **Monorepo Management**:
- Managed with [pnpm](https://pnpm.io/) workspaces for streamlined dependency management and easy package sharing between the frontend and backend.
## Getting Started
### Prerequisites
Before you begin, ensure you have met the following requirements:
- [Node.js](https://nodejs.org/) v16+ installed
- [pnpm](https://pnpm.io/) installed globally
- PostgreSQL database running
### Installation
1. Clone the repository:
```bash
git clone https://github.com/tobySolutions/stream2peer.git
cd stream2peer
```
2. Install dependencies:
```bash
pnpm install
```
3. Run the development server:
```bash
cd packages
pnpm run dev
```
### Project Structure
```bash
stream2peer/
│
├── packages/
│ ├── frontend/ # React with Vite (Client-side code)
│ └── backend/ # AdonisJS (Server-side code)
│
├── pnpm-workspace.yaml # pnpm workspace setup for monorepo
├── package.json # Root package file
└── README.md # Project documentation
```
### Backend API
The backend is powered by AdonisJS, and it handles stream creation, user management, and more. The API endpoints are RESTful and support integration with Livepeer’s transcoding API for video handling.
### Frontend
The frontend is built using React and Vite, offering a fast and optimized development environment. It allows users to interact with the Livepeer API, set up streams, invite guests, and more.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. Check out the [Contributing guide](https://github.com/tobySolutions/stream2peer/blob/main/CONTRIBUTING.md) to see how to set things up on your machine.
1. Fork the Project.
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`).
4. Push to the Branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request.
## License
Distributed under the MIT License. See [LICENSE](https://github.com/tobySolutions/stream2peer/blob/main/LICENSE) for more information.
## Acknowledgements
- [Livepeer](https://livepeer.org/)
- [AdonisJS](https://adonisjs.com/)
- [pnpm](https://pnpm.io/)
- [React](https://react.dev/)
- [Vite](https://vitejs.dev/)