https://github.com/fishjam-cloud/web-client-sdk
Web client libraries for Fishjam
https://github.com/fishjam-cloud/web-client-sdk
fishjam react typescript video webrtc
Last synced: about 2 months ago
JSON representation
Web client libraries for Fishjam
- Host: GitHub
- URL: https://github.com/fishjam-cloud/web-client-sdk
- Owner: fishjam-cloud
- License: apache-2.0
- Created: 2024-06-27T08:15:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-04T08:57:57.000Z (2 months ago)
- Last Synced: 2026-05-04T10:34:17.812Z (2 months ago)
- Topics: fishjam, react, typescript, video, webrtc
- Language: TypeScript
- Homepage: https://fishjam.io
- Size: 27.4 MB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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
To get started with the project, run npm install in the root directory to install the required dependencies and build
TypeScript:
```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).
[](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=web-readme)