npm package: @fishjam-dev/js-server-sdk
Description: Fishjam server SDK for JavaScript
Latest version: 0.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# Fishjam server SDK for JavaScript

JavaScript server-side SDK for [Fishjam](https://github.com/fishjam-dev/fishjam).

## Installation

You can install the library using `npm`:

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

## Documentation

The documentation for the latest release is available [here](https://fishjam-dev.github.io/js-server-sdk/latest).
To generate it locally, run:

```bash
npm run docs
```

For more comprehensive tutorial on the Fishjam Server, its capabilites and production usage, refer to
[Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/).

## Examples

See [examples](https://github.com/fishjam-dev/js-server-sdk/tree/main/examples) directory.

## Fishjam ecosystem

|                |                                                                                                                                                                                                                                                                                                                                       |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 📱 Client SDKs | [TypeScript](https://github.com/fishjam-dev/ts-client-sdk/) <br/> [React](https://github.com/fishjam-dev/react-client-sdk) <br/> [iOS](https://github.com/fishjam-dev/ios-client-sdk) <br/> [Android](https://github.com/fishjam-dev/android-client-sdk) <br/> [React Native](https://github.com/fishjam-dev/react-native-client-sdk) |
| ⚙️ Server SDKs | [JavaScript](https://github.com/fishjam-dev/js-server-sdk) <br/> [Python](https://github.com/fishjam-dev/python-server-sdk) <br/> [Elixir](https://github.com/fishjam-dev/elixir_server_sdk)                                                                                                                                          |
| 📚 Resources   | [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/) <br/> [Membrane Framework](https://membrane.stream/) <br/> [Join Membrane Discord!](https://discord.gg/nwnfVSY)                                                                                                                                                           |
| 🪼 Services    | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) <br/> A videoconferencing app built on top of Fishjam <br/><br/> [Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) <br/> 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](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

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