sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-19 10:57:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khoj/src/interface/desktop
History
Debanjum Singh Solanky 469a1cb6a2 Move API endpoints under /api/configure/content/ to /api/content/ 
Pull out /api/configure/content API endpoints into /api/content to
allow for more logical organization of API path hierarchy

This should make the url more succinct and API request intent more
understandable by using existing HTTP method semantics along with the
path.

The /configure URL path segment was either
- redundant (e.g POST /configure/notion) or
- incorrect (e.g GET /configure/files)

Some example of naming improvements:
- GET /configure/types -> GET /content/types
- GET /configure/files -> GET /content/files
- DELETE /configure/files -> DELETE /content/files

This should also align, merge better the the content indexing API
triggered via PUT, PATCH /content

Refactor Flow
1. Rename /api/configure/types -> /api/content/types
2. Rename /api/configure -> /api
3. Move /api/content to api_content from under api_config
2024-07-19 05:40:34 +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
loading-animation.js Replace var declarations with let declarations (#576) 2023-12-29 10:20:48 +05:30
main.js Split /api/v1/index/update into /api/content PUT, PATCH API endpoints 2024-07-19 01:45:53 +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 Expose web, desktop settings page under /settings, not /configure 2024-07-17 13:17:29 +05:30
search.html Move API endpoints under /api/configure/content/ to /api/content/ 2024-07-19 05:40:34 +05:30
settings.html Expose web, desktop settings page under /settings, not /configure 2024-07-17 13:17:29 +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 Expose web, desktop settings page under /settings, not /configure 2024-07-17 13:17:29 +05:30
yarn.lock Upgrade Desktop app package dependencies 2024-06-22 17:38:52 +05:30

README.md

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