Description: A React Vite app that adds more features on top of Jitsi to help manage meetings through an intuitive dashboard. It allows you to either connect to a meeting by pasting the url or to create an entirely new meeting.
- Installation and Requirements
- Quickstart Instructions
- Usage
- Known Issues
- Support
- Contributing
- Development
- License
- Maintainers
- Credits and References
Detailed instructions on how to install, configure, and get the project running.
You need to install the dependencies prior to following any of the steps in this section:
$ npm install
Follow this link to install Yarn if you don't have it installed.
In order to start the development server you need to run the following command:
$ npm run start
The project will run on localhost:3000.
The project first needs to build and generate the proper production-ready code, which can be achieved by running:
$ npm run build
This build script will create a build folder in the root directory, which can then be served on a local web server with the following:
$ npm run serve
The project is unit tested with Jest and these tests can be run with or without coverage output:
$ npm run test
or
$ npm run test:coverage
We are using the React wrapper around the Jitsi iFrame API found here: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe.
Just run $ yarn install && yarn dev to start the project as quickly as possible. Note that this starts the development version of the project.
The software can be used to connect to a Jitsi meeting and get some extra features that are not necessarily available in the normal Jitsi interface. Some of the features that are available are listed below:
- Mute and unmute all participants
- Send messages between breakout rooms
- Send messages to all breakout rooms
- Create breakout rooms with specific names
- It is currently not possible to join a meet.jit.si conference with the dashboard
- Jitsi instances leveraging Jitsi's own authentication mechanism are not possible to join with the dashboard
Instruct users how to get help with this software; this might include links to an issue tracker, wiki, mailing list, etc.
Example
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
This section should detail why people should get involved and describe key areas you are currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building important pieces, etc.
General instructions on how to contribute should be stated with a link to CONTRIBUTING.
This project is deployed to GitHub Pages (the deployed version can be found here), which requires the use of a HashRouter instead of BrowserRouter. This is because BrowserRouter relies on the HTML5 history API, which is not supported by GitHub Pages. HashRouter uses the URL hash to simulate a full URL and allows for proper routing on GitHub Pages. Visit this link for more information.
The Jitsi Moderator can be deployed on any Node.js web server that supports either client-side or static rendering.
It is possible to create a new meeting on the project's start page by clicking the "Create new meeting" button. The default url can be configured by adding a config file in the root folder of this project. See the example below:
{
domain: "example-jitsi-meeting-instance.com"
}
This project is licensed under the Apache 2.0 license.
License - see the LICENSE file for details
General Governance of the project is currently handled by asom (arbetsgruppen för samordning av mjukvara).
For information about the current individual or team maintainers, see CODEOWNERS.