web-client-sdk

KO | EN

gitlite — search

#ai #machine-learning #linux #docker #macos #windows #kubernetes #vue #awesome-list #security #pytorch #mcp #openai #open-source

(★ 11)

Web client libraries for Fishjam

web-client-sdk Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Ad](https://swm-delivery.com/www/images/zone-gh-fishjam-1?n=2)](https://swm-delivery.com/www/delivery/ck.php?zoneid=zone-gh-fishjam-1&n=2)
[![Ad](https://swm-delivery.com/www/images/zone-gh-fishjam-2?n=2)](https://swm-delivery.com/www/delivery/ck.php?zoneid=zone-gh-fishjam-2&n=2)
[![Ad](https://swm-delivery.com/www/images/zone-gh-fishjam-3?n=2)](https://swm-delivery.com/www/delivery/ck.php?zoneid=zone-gh-fishjam-3&n=2)

# Fishjam Web Client

React and TypeScript client libraries for [Fishjam](https://fishjam.swmansion.com/).

## Documentation

Documentation is available [here](https://fishjam.swmansion.com/docs). There
is also API documentation [here](https://fishjam.swmansion.com/docs/api).

### React Library:

[React library](https://github.com/fishjam-cloud/web-client-sdk/tree/main/packages/react-client) is useful for projects
that uses React. It is wrapper over TypeScript library, that provides React integration.

Check out [docs](https://fishjam.swmansion.com/docs/tutorials/react-quick-start) for more information.

### TypeScript Library:

[TypeScript library](https://github.com/fishjam-cloud/web-client-sdk/tree/main/packages/ts-client) is useful for
projects that do not use React. Or if you want to have more control on how all streaming events are handled.

> [!NOTE]  
> TypeScript SDK is not stable yet. We recommend using React Client

## Contributing

Contributions are always welcome, no matter how large or small!

We aspire to build a community that is friendly and respectful to each other. Please adhere to this spirit in all your
interactions within the project.

### Development Workflow

This repo uses git submodules for `packages/protobufs/protos` and `packages/react-native-webrtc`. Clone with submodules:

```bash
git clone --recurse-submodules https://github.com/fishjam-cloud/web-client-sdk.git
```

If you cloned without `--recurse-submodules`, initialize them after the fact:

```bash
git submodule update --init --recursive
```

Then install dependencies and build:

```bash
yarn
yarn build
```

Ensure your code passes TypeScript, ESLint and formatter checks by running the following commands:

```
yarn tsc
yarn lint:check
yarn format:check
```

To lint and format your code, use the following commands:

```bash
yarn lint
yarn format
```

## Submitting a Pull Request

> **Working on your first pull request?** Get started with this _free_ series:
> [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).

When you're sending a pull request:

- Focus on one change and try to keep pull requests small.
- Make sure that formatter, linter and test checks are passing.
- Review the documentation to make sure it looks good.
- Follow the pull request template when opening a pull request.
- If your pull request changes the API or implementation, first discuss the changes with the maintainers by opening an
  issue.

## License

Licensed under the [Apache License, Version 2.0](./LICENSE)

## Fishjam is created by Software Mansion

Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile
apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help
you build your next dream product –
[Hire us](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=web-readme).

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=react-client)](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=web-readme)

web-client-sdk

web-client-sdk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

web-client-sdk

web-client-sdk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README