An open API service indexing awesome lists of open source software.

https://github.com/livepeer/studio-sample-app


https://github.com/livepeer/studio-sample-app

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# ![Livepeer Studio Logo](public/favicon.ico) Livepeer Studio Sample App

A sample application that demonstrates the features of Livepeer Studio

# ⏱ Quick Start

Prerequisites: [Node (v16 LTS)](https://nodejs.org/en/download/) plus [npm](https://docs.npmjs.com/cli/v8/configuring-npm/install) and [Git](https://git-scm.com/downloads)

> clone/fork 🎥 Livepeer Studio Sample App:

```bash
git clone https://github.com/livepeer/studio-sample-app.git
```

> install Studio Sample App and dependencies:

```bash
cd studio-sample-app
npm install
```

> start Studio Sample App:

```bash
npm run dev
```

🔏 Setup environment Variable:

This sample app uses an API key from a monitored account made for public use. When customizing this for your own use, setup a `.env` file and store you API key there for security.
>Make sure to include the `.env` in the `.gitignore`

- [What are environment variables](https://www.freecodecamp.org/news/what-are-environment-variables-and-how-can-i-use-them-with-gatsby-and-netlify/)

- [dotenv](https://www.npmjs.com/package/dotenv)

- [Environment variables in NextJS](https://nextjs.org/docs/basic-features/environment-variables)
# 📼 On Demand

- Upload assets

- Update assets

- Delete assets

- Get all assets

- Get individual assets

# 🧰 On Demand SDK

- useAsset

- useUpdateAsset

- useCreateAsset

# 📡 Livestream

- Create stream

- Get all streams

- Get individual stream

- Get all sessions

- Get individual session

# 📹 Livestream SDK

- useStream

- useCreateStream

- useStreamSessions

- useUpdateStream

# 📜 Documentation

- [Livepeer Studio Docs](https://docs.livepeer.studio/)
- [Livestream Guide](https://docs.livepeer.studio/guides/livestreaming)
- [Livestream API](https://docs.livepeer.studio/references/stream/)
- [On Demand Guide](https://docs.livepeer.studio/guides/on-demand)
- [On Demand API](https://docs.livepeer.studio/references/vod/)
- [Mint Video NFT Guide](https://docs.livepeer.studio/guides/mint-guides/)

# 📖 Resources

- [NodeJS](https://nodejs.org/en/)

- [npm](https://docs.npmjs.com/cli/v8/configuring-npm/install)

- [NextJS](https://nextjs.org/)

- [tus](https://tus.io/)

- [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)

- [Axios](https://axios-http.com/)