React and TypeScript client libraries for Fishjam Cloud.
Documentation is available here. There is also API documentation here.
React library is useful for projects that uses React. It is wrapper over TypeScript library, that provides React integration.
Check out docs for more information.
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.
Note
TypeScript SDK is not stable yet. We recommend using React Client
Check out docs for more information.
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.
To get started with the project, run npm install in the root directory to install the required dependencies and build TypeScript:
yarn
yarn buildEnsure 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:
yarn lint
yarn formatWorking 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.
Licensed under the Apache License, Version 2.0
Since 2012 Software Mansion 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.