Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

Fishjam rebranding #87

Merged
merged 5 commits into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "protos"]
path = protos
url = https://github.com/jellyfish-dev/protos
url = git@github.com:fishjam-dev/protos.git
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Jellyfish Demo Dashboard</title>
<title>Fishjam Demo Dashboard</title>
<!-- Start Single Page Apps for GitHub Pages -->
<script type="text/javascript">
// Single Page Apps for GitHub Pages
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "jellyfish-dashboard",
"name": "fishjam-dashboard",
"private": true,
"version": "0.1.3",
"homepage": "https://jellyfish-dev.github.io/jellyfish-dashboard/",
"version": "0.2.0",
"homepage": "https://fishjam-dev.github.io/fishjam-dashboard/",
"type": "module",
"license": "Apache-2.0",
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"build-gh-pages": "tsc && vite build --base=/jellyfish-dashboard",
"build-gh-pages": "tsc && vite build --base=/fishjam-dashboard",
"watch": "tsc --noEmit --watch",
"preview": "vite preview",
"format:fix": "prettier --write . --ignore-path ./.eslintignore",
Expand Down
2 changes: 1 addition & 1 deletion protos
66 changes: 33 additions & 33 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
# Jellyfish Dashboard
# Fishjam Dashboard

![GitHub Repo stars](https://img.shields.io/github/stars/jellyfish-dev/jellyfish-dashboard)
![GitHub Repo stars](https://img.shields.io/github/stars/fishjam-dev/fishjam-dashboard)

## What is Jellyfish Dashboard?
## What is Fishjam Dashboard?

Jellyfish Dashboard is a web application that allows you to manage your Jellyfish Media Server instance.
It is a React application that uses the [Jellyfish React Client API](https://github.com/jellyfish-dev/react-client-sdk)
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](https://github.com/fishjam-dev/react-client-sdk)
for adding and receiving tracks
and [Jellyfish Server API](https://github.com/jellyfish-dev/jellyfish/blob/main/openapi.yaml)
and [Fishjam Server API](https://github.com/fishjam-dev/fishjam/blob/main/openapi.yaml)
for adding peers, creating rooms etc.

It was created to help Jellyfish developers in testing but was later extended and adapted as a tool for tutorials and
It was created to help Fishjam developers in testing but was later extended and adapted as a tool for tutorials and
demos.
[Here](https://jellyfish-dev.github.io/jellyfish-docs/tutorials/dashboard), we present a short introduction to the
[Here](https://fishjam-dev.github.io/fishjam-docs/tutorials/dashboard), we present a short introduction to the
dashboard and its features.

## Prerequisites

Make sure you have:

- Running [Jellyfish](https://github.com/jellyfish-dev/jellyfish) server
- Running [Fishjam](https://github.com/fishjam-dev/fishjam) server

## Usage

### Try it live

Up-to-date version is available online [here](https://jellyfish-dev.github.io/jellyfish-dashboard/)
Up-to-date version is available online [here](https://fishjam-dev.github.io/fishjam-dashboard/)

### Use docker image

```shell
docker pull ghcr.io/jellyfish-dev/jellyfish-dashboard:main
docker pull ghcr.io/fishjam-dev/fishjam-dashboard:main
```

### Run locally

```shell
git clone https://github.com/jellyfish-dev/jellyfish-dashboard.git
cd jellyfish-dashboard
git clone https://github.com/fishjam-dev/fishjam-dashboard.git
cd fishjam-dashboard
# in the cloned repo root directory
npm ci
npm run dev
Expand All @@ -51,13 +51,13 @@ Take a look at our [Dashboard quick start guide]() to get started.

### Once you have the dashboard up and running, you can

- [Try out our React examples](https://github.com/jellyfish-dev/react-client-sdk/tree/main/examples)
- [Try out our React examples](https://github.com/fishjam-dev/react-client-sdk/tree/main/examples)
- Experiment with mobile SDKs:
- [Android](https://github.com/jellyfish-dev/android-client-sdk)
- [iOS](https://github.com/jellyfish-dev/ios-client-sdk)
- [React Native](https://github.com/jellyfish-dev/react-native-client-sdk)
- [Take deep dive into Jellyfish with our documentation](https://jellyfish-dev.github.io/jellyfish-docs/)
- [Read more about our joureney to the Jellyfish Media Server](https://jellyfish-dev.github.io/book/)
- [Android](https://github.com/fishjam-dev/android-client-sdk)
- [iOS](https://github.com/fishjam-dev/ios-client-sdk)
- [React Native](https://github.com/fishjam-dev/react-native-client-sdk)
- [Take deep dive into Fishjam with our documentation](https://fishjam-dev.github.io/fishjam-docs/)
- [Read more about our joureney to the Fishjam Media Server](https://fishjam-dev.github.io/book/)

# Generate Server SDK client

Expand All @@ -67,28 +67,28 @@ npx @openapitools/openapi-generator-cli generate -i http://localhost:5002/openap

## Contributing

We welcome contributions to Jellyfish Dashboard. Please report any bugs or issues you find or feel free to make a pull
We 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 Jellyfish Dashboard can be found in [contributing](./CONTRIBUTING.md)
Detailed information about contributing to Fishjam Dashboard can be found in [contributing](./CONTRIBUTING.md)
document.

## Jellyfish Ecosystem
## Fishjam Ecosystem

| | |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Client SDKs | [React](https://github.com/jellyfish-dev/react-client-sdk), [React Native](https://github.com/jellyfish-dev/react-native-client-sdk), [iOs](https://github.com/jellyfish-dev/ios-client-sdk), [Android](https://github.com/jellyfish-dev/android-client-sdk) |
| Server SDKs | [Elixir](https://github.com/jellyfish-dev/elixir_server_sdk), [Python](https://github.com/jellyfish-dev/python-server-sdk), [OpenAPI](https://jellyfish-dev.github.io/jellyfish-docs/api_reference/rest_api) |
| Services | [Videoroom](https://github.com/jellyfish-dev/jellyfish_videoroom) - an example videoconferencing app written in elixir <br/> [Dashboard](https://github.com/jellyfish-dev/jellyfish-dashboard) - an internal tool used to showcase Jellyfish's capabilities |
| Resources | [Jellyfish Book](https://jellyfish-dev.github.io/book/) - theory of the framework, [Docs](https://jellyfish-dev.github.io/jellyfish-docs/), [Tutorials](https://github.com/jellyfish-dev/jellyfish-clients-tutorials) |
| Membrane | Jellyfish is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) |
| Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video |
| Protobufs | If you want to use Jellyfish on your own, you can use our [protobufs](https://github.com/jellyfish-dev/protos) |
| | |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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) |
| 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) |
| Services | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) - an example videoconferencing app written in elixir <br/> [Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) - an internal tool used to showcase Fishjam's capabilities |
| 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) |
| Membrane | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) |
| Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video |
| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/fishjam-dev/protos) |

## Copyright and License

Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish)
Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish)
[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

Licensed under the [Apache License, Version 2.0](LICENSE)
2 changes: 1 addition & 1 deletion src/components/SocialLinks.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { socialIcons } from "../assets/SocialIcons";

export const DASHBOARD_GITHUB = "https://github.com/jellyfish-dev/jellyfish-dashboard";
export const DASHBOARD_GITHUB = "https://github.com/fishjam-dev/fishjam-dashboard";
export const MEMBRANE_WEBPAGE = "https://membrane.stream/";
export const SWM_WEBPAGE = "https://swmansion.com/?p=1";
export const TWITTER_MEMBRANE = "https://twitter.com/ElixirMembrane";
Expand Down
Loading
Loading