freifunkMUC / jitsi-meet-electron

Jitsi Meet desktop application powered by :electron:
Apache License 2.0
26 stars 10 forks source link
hacktoberfest

Freifunk Meet Electron

Desktop application for [Jitsi] built with Electron.

Features

Installation

Download our latest release and you're off to the races!

Windows macOS GNU/Linux (AppImage) GNU/Linux (Deb)
Download Download x64_64 arm64 x86_64 arm64

NOTE: The GNU/Linux builds are 64-bit only.

WinGet (Windows)

For Windows user, you can install the application using the following command in PowerShell:

winget install --id freifunkMUC.FreifunkMeet

Homebrew (macOS)

For macOS user, you can install the application using the following command:

brew install --cask freifunkMUC/freifunkmeet/freifunk-meet

Development

If you want to hack on this project, here is how you do it.

Show building instructions #### Installing dependencies Install Node.js 16 first (or if you use [nvm](https://github.com/nvm-sh/nvm), switch to Node.js 16 by running `nvm use`).
Extra dependencies for Windows ```bash npm install --global --production windows-build-tools ```
Extra dependencies for GNU/Linux X11, PNG, and zlib development packages are necessary. On Debian-like systems, they can be installed as follows: ```bash sudo apt install libx11-dev zlib1g-dev libpng-dev libxtst-dev ```
Install all required packages: ```bash npm install ``` #### Starting in development mode ```bash npm start ``` The debugger tools are available when running in dev mode, and can be activated with keyboard shortcuts as [defined here](https://github.com/sindresorhus/electron-debug#features). They can also be displayed automatically with the application `--show-dev-tools` command line flag, or with the `SHOW_DEV_TOOLS` environment variable as shown: ```bash SHOW_DEV_TOOLS=true npm start ``` #### Building the production distribution ```bash npm run dist ``` #### Working with `jitsi-meet-electron-sdk` [`jitsi-meet-electron-sdk`] is a helper package which implements many features such as remote control and the always-on-top window. If new features are to be added or tested, running with a local version of these utils is very handy. By default, the @jitsi/electron-sdk is build from `npm`. The default dependency path in `package.json` is: ```json "@jitsi/electron-sdk": "^3.0.0" ``` To work with a local copy, you must change the path to: ```json "@jitsi/electron-sdk": "file:///Users/name/jitsi-meet-electron-sdk-copy", ``` To build the project, you must force it to take the sources, as `npm update` will not do it. ```bash npm install @jitsi/electron-sdk --force ``` NOTE: Also check the [`jitsi-meet-electron-sdk` `README`] to see how to configure your environment. #### Publishing 1. Create release branch: `git checkout -b release-1-2-3`, replacing `1-2-3` with the desired release version 2. Increment the version: `npm version patch`, replacing `patch` with `minor` or `major` as required 3. Push release branch to github: `git push -u origin release-1-2-3` 4. Create PR: `gh pr create` 5. Once PR is reviewed and ready to merge, create draft Github release: `gh release create v1.2.3 --draft --title 1.2.3`, replacing `v1.2.3` and `1.2.3` with the desired release version 6. Merge PR 7. Github action will build binaries and attach to the draft release 8. Test binaries from draft release 9. If all tests are fine, publish draft release

Known issues

Windows

A warning that the app is unsigned will show up upon first install. This is expected.

macOS

On macOS Catalina, a warning will be displayed on first install. The app won't open unless "open" is pressed. This dialog is only shown once.

GNU/Linux

NOTE for old GNU/Linux distributions You might get the following error: ``` FATAL:nss_util.cc(632)] NSS_VersionCheck("3.26") failed. NSS >= 3.26 is required. Please upgrade to the latest NSS, and if you still get this error, contact your distribution maintainer. ``` If you do, please install NSS (example for Debian or Ubuntu): ```bash sudo apt-get install libnss3 ```

Translations

The JSON files are for all the strings inside the application, and can be translated here.

New translations require the addition of a line in index.js.

Localize desktop file on linux requires the addition of a line in package.json. Please search for Comment[hu] as an example to help add your translation of the English string Jitsi Meet Desktop App for your language.

License

Apache 2. See the LICENSE file.

Community

Jitsi is built by a large community of developers. If you want to participate, please join the community forum.