Awesome
<p align="center"> <a href="https://github.com/GRVYDEV/Lightspeed-react"> <img src="images/lightspeedlogo.svg" alt="Logo" width="150" height="150"> </a> </p> <h1 align="center">Project Lightspeed React [Deprecated]</h1> <div align="center"> <a href="https://github.com/GRVYDEV/Lightspeed-react/stargazers"><img src="https://img.shields.io/github/stars/GRVYDEV/Lightspeed-react" alt="Stars Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-react/network/members"><img src="https://img.shields.io/github/forks/GRVYDEV/Lightspeed-react" alt="Forks Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-react/pulls"><img src="https://img.shields.io/github/issues-pr/GRVYDEV/Lightspeed-react" alt="Pull Requests Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-react/issues"><img src="https://img.shields.io/github/issues/GRVYDEV/Lightspeed-react" alt="Issues Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-react/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/GRVYDEV/Lightspeed-react?color=2b9348"></a> <a href="https://github.com/GRVYDEV/Lightspeed-react/blob/master/LICENSE"><img src="https://img.shields.io/github/license/GRVYDEV/Lightspeed-react?color=2b9348" alt="License Badge"/></a> </div> <br /> <p align="center"> <p align="center"> NOTE: This repo has been deprecated in favor of a monorepo configuration. Please <a href="https://github.com/GRVYDEV/Project-Lightspeed">see</a><br> A React website that connects to Lightspeed WebRTC via a websocket to negotiate SDPs and display a WebRTC stream. <!-- <br /> --> <!-- <a href="https://github.com/GRVYDEV/Lightspeed-react"><strong>Explore the docs »</strong></a> --> <br /> <br /> <a href="https://youtu.be/Dzin4_A8RDs">View Demo</a> · <a href="https://github.com/GRVYDEV/Lightspeed-react/issues">Report Bug</a> · <a href="https://github.com/GRVYDEV/Lightspeed-react/issues">Request Feature</a> </p> </p> <!-- TABLE OF CONTENTS --> <details open="open"> <summary><h2 style="display: inline-block">Table of Contents</h2></summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgements">Acknowledgements</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->About The Project
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->This is one of three components required for Project Lightspeed. Project Lightspeed is a fully self contained live streaming server. With this you will be able to deploy your own sub-second latency live streaming platform. This particular repository connects via websocket to Lightspeed WebRTC and displays a WebRTC stream. In order for this to work the Project Lightspeed WebRTC and Project Lightspeed Ingest are required.
Built With
- React
Dependencies
<!-- GETTING STARTED -->Getting Started
Setup
Docker
-
Install git
-
Build the image from the master branch with:
docker build -t grvydev/lightspeed-react https://github.com/GRVYDEV/Lightspeed-react.git
-
Run it with
docker run -it --rm \ -p 8000:80/tcp \ -e WEBSOCKET_HOST=localhost \ -e WEBSOCKET_PORT=8080 \ grvydev/lightspeed-react
Where your websocket host from the browser/client perspective is accessible on
localhost:8080
. -
You can now access it at localhost:8000.
Locally
To get a local copy up and running follow these simple steps.
Prerequisites
In order to run this npm is required. Installation instructions can be found <a href="https://www.rust-lang.org/tools/https://www.npmjs.com/get-npm">here</a>. Npm Serve is required as well if you want to host this on your machine. That can be found <a href="https://www.npmjs.com/package/serve">here</a>
Installation
git clone https://github.com/GRVYDEV/Lightspeed-react.git
cd Lightspeed-react
npm install
<!-- USAGE EXAMPLES -->
Usage
First build the frontend
cd Lightspeed-react
npm run build
You should then configure the websocket URL in config.json
in the build
directory.
Now you can host the static site locally, by using serve
for example
serve -s build -l 80
This will serve the build folder on port 80 of your machine meaning it can be retrieved via a browser by either going to your machines public IP or hostname
<!-- _For more examples, please refer to the [Documentation](https://example.com)_ --> <!-- ROADMAP -->Roadmap
See the open issues for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your 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
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Garrett Graves - @grvydev
Project Link: https://github.com/GRVYDEV/Lightspeed-react
<!-- ACKNOWLEDGEMENTS -->