Here’s a professional README file for your Broadcast System project. This document is structured to provide clear information about the project, its usage, and its features.
BRO Live Broadcast enables seamless live broadcasting of video, audio, and screen streams to all connected users (viewers). The system supports unlimited rooms, each allowing a broadcaster and many viewers, without time limitations. Users can also interact by sending messages to the broadcaster.
- Live Broadcasting: Stream audio, video, or screen in real-time.
- Interactive Messaging: Viewers can send messages to the broadcaster during the broadcast.
- Unlimited Rooms: Create multiple broadcasting rooms without time constraints.
- Cross-Platform Support: Accessible from various devices with a web browser.
To get started with the BRO Live Broadcast application, you can run it using Node.js or Docker.
- Node.js (for local installation)
- Docker and Docker Compose (for containerized deployment)
-
Clone the Repository:
git clone https://github.com/SushilkumarDev/broadcast-system.git cd broadcast-system
-
Setup Environment:
# Copy .env.template to .env and edit it if needed cp .env.template .env
-
Install Dependencies:
npm install
-
Start the Application:
npm start
-
Clone the Repository:
git clone https://github.com/SushilkumarDev/broadcast-system.git cd broadcast-system
-
Setup Environment:
# Copy .env.template to .env and edit it if needed cp .env.template .env # Copy docker-compose.template.yml to docker-compose.yml and edit it if needed cp docker-compose.template.yml docker-compose.yml
-
Run the Application:
docker-compose up -d
Once the server is running, you can access the application at:
- Home: http://localhost:3016
- Broadcaster: http://localhost:3016/broadcast?id=123&name=Broadcaster
- Viewer: http://localhost:3016/viewer?id=123&name=Viewer
The broadcaster can stream audio, video, or screen to all connected viewers and receive messages from them, while viewers can interact with the broadcaster.
You can directly join a room as a Broadcaster or Viewer by specifying the room ID and your name.
As | URL |
---|---|
Broadcaster |
http://localhost:3016/broadcast?id=123&name=Broadcaster |
Viewer |
http://localhost:3016/viewer?id=123&name=Viewer |
Params | Type | Description |
---|---|---|
id | string | Room ID |
name | string | User name |
To embed the MiroTalk Live Broadcast into your service or app using an iframe, use the following code snippet:
<iframe
allow="camera; microphone; display-capture; fullscreen; clipboard-read; clipboard-write; web-share; autoplay"
src="https://bro.mirotalk.com"
style="height: 100vh; width: 100vw; border: 0px;"
></iframe>
This project is licensed under the MIT License. See the LICENSE file for more details.
Contributions are welcome! If you would like to contribute, please follow these steps:
- Fork the repository.
- Create a feature branch (
git checkout -b feature/AmazingFeature
). - Commit your changes (
git commit -m 'Add some AmazingFeature'
). - Push to the branch (
git push origin feature/AmazingFeature
). - Open a pull request.
If you find this project useful, consider supporting its development by buying me a coffee!
For any inquiries or feedback, please contact me at [email protected].
Feel free to customize sections as needed, especially the repository URL, and add any additional information that you think might be helpful!