Skip to content
GitLab

WIP: Add Electron support

Closed Creak requested to merge creak/funkwhale:896-add-electron-support into develop

Disclaimer: I am discovering both Electron and the Funkwhale code base at the same time, any help would be greatly appreciated! 😉

This MR is based on !853 (closed).

Closes #896 (closed)

ToDo

  • Add media keys for Linux
  • Add app name (currently it's "front")
  • Add the app to the systray
  • Add notifications
  • Add functionality to choose your remote server through the front end
  • Tests

Done

  • Decouple the Electron dependencies and code from the web app
  • Add Funkwhale icon
  • Add Electron
  • A changelog fragment

Setup

From CONTRIBUTING.rst:

Install Electron-related dependencies:

yarn electron:install

Run the app in development mode:

yarn electron:serve

Build a production version of the app:

yarn electron:build

Run the app built with yarn electron:build:

./dist_electron/front-0.1.0.AppImage

Connect to a specific server

In order to test the Electron application with your server, you need to set the WEBPACK_DEV_SERVER_URL environment variable. Like this:

WEBPACK_DEV_SERVER_URL=https://funkwhale.yourdomain.com yarn electron:serve

Or

WEBPACK_DEV_SERVER_URL=https://funkwhale.yourdomain.com ./dist_electron/front-0.1.0.AppImage
Edited by Creak