https://github.com/fishjam-cloud/js-server-sdk
JavaScript Server SDK for Fishjam
https://github.com/fishjam-cloud/js-server-sdk
fishjam video webrtc
Last synced: 3 months ago
JSON representation
JavaScript Server SDK for Fishjam
- Host: GitHub
- URL: https://github.com/fishjam-cloud/js-server-sdk
- Owner: fishjam-cloud
- License: apache-2.0
- Created: 2024-06-17T13:40:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-03T11:50:16.000Z (5 months ago)
- Last Synced: 2026-02-04T01:44:22.920Z (5 months ago)
- Topics: fishjam, video, webrtc
- Language: TypeScript
- Homepage: https://fishjam.io
- Size: 3.47 MB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fishjam Server SDK
TypeScript SDK that can be used to run server logic for [Fishjam](https://fishjam.io).
This is required to have custom user authentication logic.
## Installation
To install SDK you can use `npm` or `yarn` commands:
```bash
npm install @fishjam-cloud/js-server-sdk
```
or
```bash
yarn add @fishjam-cloud/js-server-sdk
```
## Documentation
API documentation is available [here](https://fishjam-cloud.github.io/js-server-sdk/)
### Room Manager example
[Room Manager](./examples/room-manager/) is simple application that can be used to start your work on custom code. This app is also available from Fishjam web panel for each staging environment.
## 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
```
## 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=js-server-readme).
[](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=js-server-readme)