mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-12-20 19:37:45 +00:00
ad59180fb8
* Changed the styling of the link that takes a user to the settings page into a button * added an indicator that shows if a user is connected to the server or not * made a class name more descriptive and also made the text in first run message more intuitive * changed the command to install dependencies in the README.md * changed the class name of the first run message text to be more descriptive * added icons in the desktop UI that shows if a file is synced successfully or not * made the link class name in the homepage more descriptive * fixed the hover issue on status box in the chat header pane * fixed hovering issue on status box on macOS
37 lines
905 B
Markdown
37 lines
905 B
Markdown
# Run it locally
|
|
|
|
## Prerequisites
|
|
|
|
Install the runtime dependencies. This command should install all dev dependencies.
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
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)"`.
|