Skip to content

Latest commit

 

History

History
185 lines (130 loc) · 6.22 KB

README.md

File metadata and controls

185 lines (130 loc) · 6.22 KB
Raw

Logo

Project Lightspeed React [Deprecated]

Stars Badge Forks Badge Pull Requests Badge Issues Badge GitHub contributors License Badge

NOTE: This repo has been deprecated in favor of a monorepo configuration. Please see
A React website that connects to Lightspeed WebRTC via a websocket to negotiate SDPs and display a WebRTC stream.

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

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

Setup

Docker

  1. Install git

  2. Build the image from the master branch with:

    docker build -t grvydev/lightspeed-react https://github.com/GRVYDEV/Lightspeed-react.git

  3. 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.

  4. 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 here. Npm Serve is required as well if you want to host this on your machine. That can be found here

Installation

git clone https://github.com/GRVYDEV/Lightspeed-react.git
cd Lightspeed-react
npm install

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

Roadmap

See the open issues for a list of proposed features (and known issues).

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.

  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 for more information.

Contact

Garrett Graves - @grvydev

Project Link: https://github.com/GRVYDEV/Lightspeed-react

Acknowledgements