khoj/src/interface/desktop
2023-11-03 05:15:41 -07:00
..
assets Show splash screen on starting desktop app 2023-11-03 03:19:08 -07:00
chat.html Console log a welcome message on loading Desktop client 2023-11-03 05:15:41 -07:00
config.html Console log a welcome message on loading Desktop client 2023-11-03 05:15:41 -07:00
khoj.js Console log a welcome message on loading Desktop client 2023-11-03 05:15:41 -07:00
loading-animation.js Slow down spinning at end of splash sequence. Make animation bigger 2023-11-03 04:28:17 -07:00
main.js Show splash screen on starting desktop app 2023-11-03 03:19:08 -07:00
package.json Release Khoj version 0.13.0 2023-10-18 03:43:54 -07:00
preload.js [Multi-User Part 4]: Authenticate using API Tokens (#513) 2023-10-26 12:33:03 -07:00
README.md Add front-end Electron application for Khoj local file syncing (#473) 2023-09-06 12:04:18 -07:00
renderer.js Render each file, folder to index row with icon in desktop app 2023-11-03 02:48:42 -07:00
search.html Console log a welcome message on loading Desktop client 2023-11-03 05:15:41 -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
yarn.lock Update Khoj package version for Electron, Desktop app (#492) 2023-10-03 12:21:32 -07:00

Run it locally

Prerequisites

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

yarn add

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)".