The Livepeer project aims to deliver a live video streaming network protocolthat is fully decentralized, highly scalable, crypto token incentivized, andresults in a solution which can serve as the live media layer in thedecentralized development (web3) stack. You can learn more about the protocoland economic incentives by readingour whitepaper.
This monorepo contains JavaScript tools and applications that interact withLivepeer's smart contracts and peer-to-peer network.
Table of Contents
Requirements
This project requires node >=10.0.0 and yarn >=1.0.0. A unix shell is alsorequired.
Getting Started
To get started, clone the repo and install its dependencies:
git clone https://github.com/livepeer/livepeerjs.git
cd livepeerjs
yarn
For development purposes there's a top-level dev script that will watch andcontinuously compile all packages concurrently:
yarn dev
For next steps, take a look at documentation for the individual package(s) youwant to run and/or develop.
Contributing
Thanks for your interest in LivepeerJS. There are many ways you can contribute.To start, take a few minutes to look over the official guide:
Read the "Contributing to LivepeerJS" Guide »
We happily await your pull requests and/or involvement in ourissues page and hope to seeyour username on ourlist of contributors
Packages
Published
| Name | Version | Description |
|---|---|---|
@livepeer/chroma |
A component library that contains some UI building blocks for livestreaming video applications. | |
@livepeer/lpx |
A command line protocol explorer. It has a console mode that allows you to interactively use the sdk. | |
@livepeer/sdk |
A module for interacting with Livepeer's smart contracts. A core dependency of most LivepeerJS projects. |
Private
| Name | Description |
|---|---|
@livepeer/player |
A video player for the web. Lets you see what's live streaming on the network. Our hosted media player runs off of this project. See it live at media.livepeer.org |
@livepeer/subgraph |
Subgraph manifest for The Graph |
Resources
To get a full idea of what Livepeer is about, be sure to take a look at theseother resources: