@livepeer/lpx
npm i @livepeer/lpx

@livepeer/lpx

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

by livepeer

1.0.0-alpha.6 (see all)License:MITTypeScript:Not Found
npm i @livepeer/lpx
Readme

LivepeerJS


Discord CircleCI Code Climate license code style: prettier Commitizen friendly lerna 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.

Table of Contents

Requirements

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

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 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 »

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                                        Version            Description
@livepeer/chromanpmA component library that contains some UI building blocks for livestreaming video applications.
@livepeer/lpxnpmA command line protocol explorer. It has a console mode that allows you to interactively use the sdk.
@livepeer/sdknpmA module for interacting with Livepeer's smart contracts. A core dependency of most LivepeerJS projects.

Private

NameDescription
@livepeer/playerA 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/subgraphSubgraph 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:

Downloads/wk

15

GitHub Stars

166

LAST COMMIT

4mos ago

MAINTAINERS

2

CONTRIBUTORS

34

OPEN ISSUES

0

OPEN PRs

1
VersionTagPublished
1.0.0-alpha.6
latest
3yrs ago
No alternatives found
No tutorials found
Add a tutorial