Skip to content

Latest commit

 

History

History
 
 

baklava

README.md

Dogehouse for Desktop (Baklava)

This is the desktop application for Dogehouse. It uses ElectronJS as a wrapper for dogehouse.tv and adds other native capabilities.

Features

  • Notifications
  • System tray
  • Global keybinds
  • Splash screen
  • Localization
  • Discord RPC

How to run

NOTE: Windows users may have to install Visual Studio 2019 and the workload Desktop Development with C++.

  • Run yarn install
  • Ensure Rust is installed
  • Install nj-cli by running cargo install nj-cli
  • Run yarn build:globalkey
  • Run yarn start
  • (Optional) Run yarn build:%YOUR_PLATFORM_CODE% and install the app from the build (located in /builds)

If you encounter any errors while building please create a new issue for it or ask for help on the Discord.

Using hot reload

The electron wrapper has the capability for hot reloads during development. You can run the app in hot reload mode using yarn dev.

While in hot reload mode, any time you save changes to a ts file, the electron app will recompile and relaunch itself. To exit hot reload mode, use Ctrl+C in the console. This will however, leave the current app window open, so be sure to close that also, as it will no longer have access to hot reload.

Translations

Translations are stored in baklava/locales and loaded using the i18next library. You can add new languages by creating a folder with the correct language code and adding the translate.json file. All keys are present in baklava/src/generated/translationKeys.ts, so it's a good idea to use it for reference.

You can sync the files and generate missing keys using yarn i18.