{"id":18465164,"url":"https://github.com/fishjam-dev/fishjam-dashboard","last_synced_at":"2025-04-08T08:31:43.464Z","repository":{"id":180176621,"uuid":"663880726","full_name":"fishjam-dev/fishjam-dashboard","owner":"fishjam-dev","description":"Application that allows you to manage your Fishjam Media Server instances","archived":false,"fork":false,"pushed_at":"2024-05-22T13:24:52.000Z","size":721,"stargazers_count":7,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-22T14:05:29.678Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://fishjam-dev.github.io/fishjam-dashboard/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fishjam-dev.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-08T10:42:49.000Z","updated_at":"2024-06-03T11:13:53.657Z","dependencies_parsed_at":"2023-09-21T18:44:04.724Z","dependency_job_id":"f895298e-7acc-4ff0-99e3-c3f86ea5ac59","html_url":"https://github.com/fishjam-dev/fishjam-dashboard","commit_stats":null,"previous_names":["jellyfish-dev/jellyfish-dashboard","fishjam-dev/fishjam-dashboard"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjam-dev%2Ffishjam-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjam-dev%2Ffishjam-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjam-dev%2Ffishjam-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjam-dev%2Ffishjam-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fishjam-dev","download_url":"https://codeload.github.com/fishjam-dev/fishjam-dashboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247804524,"owners_count":20999003,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T09:12:11.851Z","updated_at":"2025-04-08T08:31:42.930Z","avatar_url":"https://github.com/fishjam-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fishjam Dashboard\n\n![GitHub Repo stars](https://img.shields.io/github/stars/fishjam-dev/fishjam-dashboard)\n\n## What is Fishjam Dashboard?\n\nFishjam Dashboard is a web application that allows you to manage your Fishjam Media Server instance.\nIt is a React application that uses the [Fishjam React Client API](https://github.com/fishjam-dev/react-client-sdk)\nfor adding and receiving tracks\nand [Fishjam Server API](https://github.com/fishjam-dev/fishjam/blob/main/openapi.yaml)\nfor adding peers, creating rooms etc.\n\nIt was created to help Fishjam developers in testing but was later extended and adapted as a tool for tutorials and\ndemos.\n[Here](https://fishjam-dev.github.io/fishjam-docs/tutorials/dashboard), we present a short introduction to the\ndashboard and its features.\n\n## Prerequisites\n\nMake sure you have:\n\n- Running [Fishjam](https://github.com/fishjam-dev/fishjam) server\n\n## Usage\n\n### Try it live\n\nUp-to-date version is available online [here](https://fishjam-dev.github.io/fishjam-dashboard/)\n\n### Use docker image\n\n```shell\ndocker pull ghcr.io/fishjam-dev/fishjam-dashboard:main\n```\n\n### Run locally\n\n```shell\ngit clone https://github.com/fishjam-dev/fishjam-dashboard.git\ncd fishjam-dashboard\n# in the cloned repo root directory\nnpm ci\nnpm run dev\n```\n\n## Quick start\n\nTake a look at our [Dashboard quick start guide]() to get started.\n\n## Next steps\n\n### Once you have the dashboard up and running, you can\n\n- [Try out our React examples](https://github.com/fishjam-dev/react-client-sdk/tree/main/examples)\n- Experiment with mobile SDKs:\n  - [Android](https://github.com/fishjam-dev/android-client-sdk)\n  - [iOS](https://github.com/fishjam-dev/ios-client-sdk)\n  - [React Native](https://github.com/fishjam-dev/react-native-client-sdk)\n- [Take deep dive into Fishjam with our documentation](https://fishjam-dev.github.io/fishjam-docs/)\n- [Read more about our joureney to the Fishjam Media Server](https://fishjam-dev.github.io/book/)\n\n# Generate Server SDK client\n\n```shell\nnpx @openapitools/openapi-generator-cli generate -i http://localhost:5002/openapi.json -g typescript-axios -o ./src/server-sdk\n```\n\n## Contributing\n\nWe welcome contributions to Fishjam Dashboard. Please report any bugs or issues you find or feel free to make a pull\nrequest with your own bug fixes and/or features.\n\nDetailed information about contributing to Fishjam Dashboard can be found in [contributing](./CONTRIBUTING.md)\ndocument.\n\n## Fishjam Ecosystem\n\n|             |                                                                                                                                                                                                                                                      |\n| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Client SDKs | [React](https://github.com/fishjam-dev/react-client-sdk), [React Native](https://github.com/fishjam-dev/react-native-client-sdk), [iOs](https://github.com/fishjam-dev/ios-client-sdk), [Android](https://github.com/fishjam-dev/android-client-sdk) |\n| Server SDKs | [Elixir](https://github.com/fishjam-dev/elixir_server_sdk), [Python](https://github.com/fishjam-dev/python-server-sdk), [OpenAPI](https://fishjam-dev.github.io/fishjam-docs/api_reference/rest_api)                                                 |\n| Services    | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) - an example videoconferencing app written in elixir \u003cbr/\u003e [Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) - an internal tool used to showcase Fishjam's capabilities    |\n| Resources   | [Fishjam Book](https://fishjam-dev.github.io/book/) - theory of the framework, [Docs](https://fishjam-dev.github.io/fishjam-docs/), [Tutorials](https://github.com/fishjam-dev/fishjam-clients-tutorials)                                            |\n| Membrane    | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY)                                                                                                                                                      |\n| Compositor  | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video                                                                                                                             |\n| Protobufs   | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/fishjam-dev/protos)                                                                                                                                           |\n\n## Copyright and License\n\nCopyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git\u0026utm_medium=readme\u0026utm_campaign=fishjam)\n\n[![Software Mansion](https://logo.swmansion.com/logo?color=white\u0026variant=desktop\u0026width=200\u0026tag=membrane-github)](https://swmansion.com/?utm_source=git\u0026utm_medium=readme\u0026utm_campaign=fishjam)\n\nLicensed under the [Apache License, Version 2.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishjam-dev%2Ffishjam-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffishjam-dev%2Ffishjam-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishjam-dev%2Ffishjam-dashboard/lists"}