View on GitHub


Test Coverage
<!-- show-on-docup
<br />



[![Code Climate](](
[![code style: prettier](](
[![Commitizen friendly](](
[![Contributions welcome](](

The Livepeer project aims to deliver a live video streaming network protocol
that is fully decentralized, highly scalable, crypto token incentivized, and
results in a solution which can serve as the live media layer in the
decentralized development (web3) stack. You can learn more about the protocol
and economic incentives by reading
[our whitepaper](

This monorepo contains JavaScript tools and applications that interact with
Livepeer's smart contracts and peer-to-peer network.

<!-- hide-on-docup-start -->

## Table of Contents

- [Requirements](#requirements)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [Packages](#packages)
- [Resources](#resources)

<!-- hide-on-docup-stop -->

## Requirements

This project requires `node >=10.0.0` and `yarn >=1.0.0`. A unix shell is also

- [Installing Node](
- [Installing Yarn](
- [UNIX Shell (Windows users)](

## Getting Started

To get started, clone the repo and install its dependencies:

git clone
cd livepeerjs

For development purposes there's a top-level `dev` script that will watch and
continuously compile all packages concurrently:

yarn dev

For next steps, take a look at documentation for the individual package(s) you
want 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 &raquo;](**

We happily await your pull requests and/or involvement in our
[issues page]( and hope to see
your username on our
[list of contributors](

## Packages

### Published

| Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Version&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;                                               | Description                                                                                              |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| [`@livepeer/chroma`](                                                                                                                                                             | [![npm](]( | A component library that contains some UI building blocks for livestreaming video applications.          |
| [`@livepeer/lpx`](                                                                                                                                                                   | [![npm](](       | A command line protocol explorer. It has a console mode that allows you to interactively use the sdk.    |
| [`@livepeer/sdk`](                                                                                                                                                                   | [![npm](](       | 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 []( |
| [`@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 these
other resources:

- 🌐 [The Livepeer Website](
- 🔭 [The 10-Minute Primer](
- ✍ [The Livepeer Blog](
- 📖 [The Livepeer Docs](
- 💬 [The Livepeer Chat](
- ❓ [The Livepeer Forum](