Fishjam Dashboard is a web application that allows you to manage your Fishjam Media Server instance. It is a React application that uses the Fishjam React Client API for adding and receiving tracks and Fishjam Server API for adding peers, creating rooms etc.
It was created to help Fishjam developers in testing but was later extended and adapted as a tool for tutorials and demos. Here, we present a short introduction to the dashboard and its features.
Make sure you have:
- Running Fishjam server
Up-to-date version is available online here
docker pull ghcr.io/fishjam-dev/fishjam-dashboard:maingit clone https://github.com/fishjam-dev/fishjam-dashboard.git
cd fishjam-dashboard
# in the cloned repo root directory
npm ci
npm run devTake a look at our Dashboard quick start guide to get started.
- Try out our React examples
- Experiment with mobile SDKs:
- Take deep dive into Fishjam with our documentation
- Read more about our joureney to the Fishjam Media Server
npx @openapitools/openapi-generator-cli generate -i http://localhost:5002/openapi.json -g typescript-axios -o ./src/server-sdkWe welcome contributions to Fishjam Dashboard. Please report any bugs or issues you find or feel free to make a pull request with your own bug fixes and/or features.
Detailed information about contributing to Fishjam Dashboard can be found in contributing document.
| Client SDKs | React, React Native, iOs, Android |
| Server SDKs | Elixir, Python, OpenAPI |
| Services | Videoroom - an example videoconferencing app written in elixir Dashboard - an internal tool used to showcase Fishjam's capabilities |
| Resources | Fishjam Book - theory of the framework, Docs, Tutorials |
| Membrane | Fishjam is based on Membrane, Discord |
| Compositor | Compositor - Membrane plugin to transform video |
| Protobufs | If you want to use Fishjam on your own, you can use our protobufs |
Copyright 2023, Software Mansion
Licensed under the Apache License, Version 2.0