khoj/src/interface/desktop/README.md

# Run it locally
## Prerequisites
Install the runtime dependencies. This command should install all dev dependencies.
```bash
yarn add
```

Run the application
```bash
yarn start
```
# Deploying the Electron App
## Prerequisites
Install the ToDesktop CLI. Full documentation can be found here: https://www.npmjs.com/package/@todesktop/cli
```bash
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.

```bash
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)"`.
Add front-end Electron application for Khoj local file syncing (#473) * Initial version - setup a file-push architecture for generating embeddings with Khoj * Use state.host and state.port for configuring the URL for the indexer * Fix parsing of PDF files * Read markdown files from streamed data and update unit tests * On application startup, load in embeddings from configurations files, rather than regenerating the corpus based on file system * Init: refactor indexer/batch endpoint to support a generic file ingestion format * Add features to better support indexing from files sent by the desktop client * Initial commit with Electron application - Adds electron app * Add import for pymupdf, remove import for pypdf * Allow user to configure khoj host URL * Remove search type configuration from index.html * Use v1 path for current indexer routes 2023-09-06 19:04:18 +00:00			`# Run it locally`
			`## Prerequisites`
			`Install the runtime dependencies. This command should install all dev dependencies.`
			```bash
			`yarn add`
			```

			`Run the application`
			```bash
			`yarn start`
			```
			`# Deploying the Electron App`
			`## Prerequisites`
			`Install the ToDesktop CLI. Full documentation can be found here: https://www.npmjs.com/package/@todesktop/cli`
			```bash
			`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.`

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