Fishjam Cloud Web Client

React and TypeScript client libraries for Fishjam Cloud.

Installation

To install SDK you can use npm or yarn commands:

React Library:

React library is useful for projects that uses React. It is wrapper over TypeScript library, that provides React integration.

npm install @fishjam-cloud/react-client

or

yarn add @fishjam-cloud/react-client

TypeScript Library:

TypeScript library is useful for projects that do not use React. Or if you want to have more control on how all streaming events are handled.

npm install @fishjam-cloud/ts-client

or

yarn add @fishjam-cloud/ts-client

Documentation

For more information visit React Client or TypeScript Client website.

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:

yarn
yarn build

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

yarn typecheck
yarn lint:check
yarn format:check

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

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.

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.

Copyright and License

Copyright 2024, Software Mansion

Licensed under the Apache License, Version 2.0