LivepeerJS

Getting Started

First, clone this repo

git clone https://github.com/livepeer/livepeerjs.git

Next, cd into the cloned repo and install project dependencies

cd livepeerjs
# this project uses yarn, so if you don't have it,
# install it by running `npm i -g yarn`
yarn

For next steps, take a look at documentation for the individual project(s) you want to run and/or develop. Just follow the links in the next section.

This repo is the home of the following projects and libraries:

@livepeer/apollo

A project that integrates with @livepeer/graphql-sdk with apollo.
@livepeer/chroma

A component library that contains some UI building blocks for livestreaming video applications.
@livepeer/explorer

A protocol explorer for the web. It allows users to see general information about the protocol and specific information about Eth addresses within the protocol.
@livepeer/graphql-sdk

A GraphQL API that can be used to simplify protocol interaction. It can be used directly in the browser or in node.js applications.
@livepeer/lpx

A command line protocol explorer. It has a console mode that allows you to interactively use the sdk.
@livepeer/player

A video player for the web. Lets you see what's live streaming on the network. Our hosted media player (media.livepeer.org) runs off of this project.
@livepeer/sdk

A module for interacting with Livepeer's smart contracts. A core dependency of most projects in this repo.

To get a full idea of what Livepeer is about, be sure to take a look at these other resources: