khoj/src/interface/desktop
Debanjum Singh Solanky e24ca9ec28 Pass file path of each doc reference in references returned by API
- Pass file path of reference along with the compiled reference in
  list of references returned by chat API converts
- Update the structure of references from list of strings to list of
  dictionary (containing 'compiled' and 'file' keys)
- Pull out the compiled reference from the new references data struct
  wherever it was is being used
2024-05-26 18:02:11 +05:30
..
assets Added indication in the desktop UI for back-end connectivity (#711) 2024-04-23 16:43:48 +05:30
about.html Improve PWA install experience for Khoj on Desktop, Mobile 2024-02-23 18:59:52 +05:30
chat.html Pass file path of each doc reference in references returned by API 2024-05-26 18:02:11 +05:30
config.html Added indication in the desktop UI for back-end connectivity (#711) 2024-04-23 16:43:48 +05:30
loading-animation.js Replace var declarations with let declarations (#576) 2023-12-29 10:20:48 +05:30
main.js Skip trying to index deleted files, folders from Desktop app 2024-04-25 15:23:05 +05:30
package.json Release Khoj version 1.12.0 2024-05-01 16:30:48 +05:30
preload.js Dynamically generate navigation menu based on user info from server 2024-04-10 10:34:36 +05:30
README.md Added indication in the desktop UI for back-end connectivity (#711) 2024-04-23 16:43:48 +05:30
renderer.js Added indication in the desktop UI for back-end connectivity (#711) 2024-04-23 16:43:48 +05:30
search.html Add a hero image for the og:image meta tag 2024-04-27 17:07:21 +05:30
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 Added indication in the desktop UI for back-end connectivity (#711) 2024-04-23 16:43:48 +05:30
yarn.lock Just use file ext to identify indexable files to fix Desktop app install 2024-04-12 11:16:07 +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)".