Skip to content
This repository has been archived by the owner on Aug 2, 2024. It is now read-only.

fishjam-dev/js-server-sdk

Repository files navigation

Fishjam server SDK for JavaScript

JavaScript server-side SDK for Fishjam.

Installation

You can install the library using npm:

npm install @fishjam-dev/js-server-sdk

Documentation

The documentation for the latest release is available here. To generate it locally, run:

npm run docs

For more comprehensive tutorial on the Fishjam Server, its capabilites and production usage, refer to Fishjam docs.

Examples

See examples directory.

Fishjam ecosystem

📱 Client SDKs TypeScript
React
iOS
Android
React Native
⚙️ Server SDKs JavaScript
Python
Elixir
📚 Resources Fishjam Docs
Membrane Framework
Join Membrane Discord!
🪼 Services Videoroom
A videoconferencing app built on top of Fishjam

Dashboard
An all-around development tool for Fishjam

Contributing

We welcome contributions to this SDK. Please report any bugs or issues you find or feel free to make a pull request with your own bug fixes or features.

Releasing new versions

To release a new version of the package, go to Actions > Release package workflow and trigger it with the chosen release type. The workflow will bump the package version in package.json, release the package to NPM, create a new git tag and a GitHub release.

Copyright and License

Copyright 2024, Software Mansion

Software Mansion

Licensed under the Apache License, Version 2.0