khoj/src/interface/desktop
Debanjum Singh Solanky 59000a47cb Move Desktop config page to /configure from /config url path
Update references to point to page at /configure instead of /config
2024-07-16 16:13:27 +05:30
..
assets Fix multilingual font rendering (#797) 2024-06-07 11:53:47 +05:30
about.html Improve PWA install experience for Khoj on Desktop, Mobile 2024-02-23 18:59:52 +05:30
chat.html Add Keyboard shortcuts to navigate in Khoj Desktop 2024-07-11 16:29:53 +05:30
chatutils.js Add OS Level Shortcut Window for Quick Access to Khoj Desktop (#815) 2024-06-27 07:20:13 -07:00
configure.html Move Desktop config page to /configure from /config url path 2024-07-16 16:13:27 +05:30
loading-animation.js Replace var declarations with let declarations (#576) 2023-12-29 10:20:48 +05:30
main.js Move Web client config page to /configure from /config url path 2024-07-16 16:13:27 +05:30
package.json Release Khoj version 1.16.0 2024-07-07 18:26:10 +05:30
preload.js Add OS Level Shortcut Window for Quick Access to Khoj Desktop (#815) 2024-06-27 07:20:13 -07:00
README.md Added indication in the desktop UI for back-end connectivity (#711) 2024-04-23 16:43:48 +05:30
renderer.js Move Web client config page to /configure from /config url path 2024-07-16 16:13:27 +05:30
search.html Move Desktop config page to /configure from /config url path 2024-07-16 16:13:27 +05:30
shortcut.html Add OS Level Shortcut Window for Quick Access to Khoj Desktop (#815) 2024-06-27 07:20:13 -07:00
splash.html Show splash screen on starting desktop app 2023-11-03 03:19:08 -07:00
todesktop.json Add front-end Electron application for Khoj local file syncing (#473) 2023-09-06 12:04:18 -07:00
utils.js Move Desktop config page to /configure from /config url path 2024-07-16 16:13:27 +05:30
yarn.lock Upgrade Desktop app package dependencies 2024-06-22 17:38:52 +05:30

Run it locally

Prerequisites

Install the runtime dependencies. This command should install all dev dependencies.

yarn install

Run the application

yarn start

Deploying the Electron App

Prerequisites

Install the ToDesktop CLI. Full documentation can be found here: https://www.npmjs.com/package/@todesktop/cli

yarn global add @todesktop/cli

Configure the todesktop.json file. Fill in the id based on the application ID.

Build

This will prompt you to login. It triggers builds for all platforms.

todesktop build

If you get an error saying the command is not found, make sure that your yarn global bin directory is in your PATH environment variable. You can find the location of the global bin directory by running yarn global bin. Add this line to your .bashrc or .zshrc file: export PATH="$PATH:$(yarn global bin)".