Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 2.47 KB

README.md

File metadata and controls

69 lines (43 loc) · 2.47 KB

Fishjam Cloud Server SDK

TypeScript SDK that can be used to run server logic for Fishjam Cloud. This is required to have custom user authentication logic.

Installation

To install SDK you can use npm or yarn commands:

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

or

yarn add @fishjam-cloud/js-server-sdk

Documentation

API documentation is available here

Room Manager example

Room Manager is simple application that can be used to start your work on custom code. This app is also available from Fishjam Cloud 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:

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.

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

Fishjam Cloud is created by Software Mansion

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.

Software Mansion