# @arbiter-framework/sdk

> ![arbiter_banner](https://github.com/Arbiter-WRTC/client/assets/57457673/55b44136-8c74-4e0d-b970-b53eabdb020a)

Latest version **0.2.12** (published 2023-12-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @arbiter-framework/sdk
pnpm add @arbiter-framework/sdk
yarn add @arbiter-framework/sdk
bun add @arbiter-framework/sdk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.12 |
| Published | 2023-12-11 |
| First published | 2023-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | arbiter |
| Maintainers | watzmonium |

## Links

- npm: https://www.npmjs.com/package/@arbiter-framework/sdk
- Repository: https://github.com/Arbiter-WRTC/client
- Homepage: https://github.com/Arbiter-WRTC/client#readme
- Issues: https://github.com/Arbiter-WRTC/client/issues
- npm.io page: https://npm.io/package/@arbiter-framework/sdk

## Dependencies (9)

- [uuid](https://npm.io/package/uuid.md) ^9.0.1
- [axios](https://npm.io/package/axios.md) ^1.6.1
- [react](https://npm.io/package/react.md) ^18.2.0
- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [react-spring](https://npm.io/package/react-spring.md) ^9.7.3
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^4.7.2
- [styled-components](https://npm.io/package/styled-components.md) ^6.1.0
- [@vitejs/plugin-basic-ssl](https://npm.io/package/@vitejs/plugin-basic-ssl.md) ^1.0.1

## Recent versions

- 0.2.12 (latest) — 2023-12-11
- 0.2.11 — 2023-12-11
- 0.2.10 — 2023-12-11
- 0.2.9 — 2023-12-11
- 0.2.8 — 2023-12-11
- 0.2.7 — 2023-12-11
- 0.2.6 — 2023-12-11
- 0.2.5 — 2023-12-11
- 0.2.4 — 2023-12-11
- 0.2.3 — 2023-12-11
- 0.2.2 — 2023-12-11
- 0.2.1 — 2023-12-11
- 0.2.0 — 2023-12-11
- 0.1.0 — 2023-12-11

## README

![arbiter_banner](https://github.com/Arbiter-WRTC/client/assets/57457673/55b44136-8c74-4e0d-b970-b53eabdb020a)

## Overview

Arbiter's React SDK is built using React with Vite and Typescript.
<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original-wordmark.svg" alt="react" width="40" height="40"/>
<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="typescript" width="40" height="40"/>

To use Arbiter's SDK, the Arbiter infrastructure must first be provisioned using the CLI tool. You can visit the arbiter-cli repository to complete this step if necessary. Once deployed, Arbiter's CLI tool will provide you with a `.env.local` file to use with Arbiter's SDK.

To integrate, first download the Arbiter npm package with
`npm install @Arbiter/SDK`

Then, import into your existing React application like the following example:
```ts
import Arbiter 'from @Arbiter/SDK';

const App = () => {
   # your code here...
   <Arbiter />;
};

export default App
```

INSERT PICTURE OF FRONTEND

Arbiter should work seamlessly with your existing frontend application, and room provisioning will be based on the URL path of the page in question. This allows you to integrate rooms dynamically based on the content. It is important to note that all users who visit that page will be able to join the call for that route, so adding authentication to prevent unauthorized use is a best practice when using Arbiter.

## The Team

**<a href="https://github.com/watzmonium" target="_blank">Stephen Watzman</a>** _Software Engineer_ • Detroit, MI

**<a href="https://github.com/frye-t" target="_blank">Tyler Frye</a>** _Software Engineer_ • Tampa Bay, FL

**<a href="https://github.com/jayjayabose" target="_blank">Jay Jayabose</a>** _Software Engineer_ • New York, NY

---
_Source: https://npm.io/package/@arbiter-framework/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
