LightRAG/lightrag_webui
2025-03-26 10:31:18 +08:00
..
public feat: retrieval message code highlight, message copy button 2025-02-24 18:17:17 +08:00
src fix: add missing t dependency in ClearDocumentsDialog useCallback 2025-03-26 10:31:18 +08:00
.gitignore move lightrag_webui folder to top directory 2025-02-13 17:29:51 +08:00
.prettierrc.json move lightrag_webui folder to top directory 2025-02-13 17:29:51 +08:00
bun.lock Merge branch 'loginPage' into webui-node-expansion 2025-03-18 00:39:48 +08:00
components.json move lightrag_webui folder to top directory 2025-02-13 17:29:51 +08:00
env.development.smaple Added sample environment configuration files for webui development and local setups. 2025-03-16 14:13:26 +08:00
env.local.sample Added root redirect to /webui and updated webui config 2025-03-18 15:38:41 +08:00
eslint.config.js enhance web UI with retrieval testing and UI improvements 2025-02-16 04:34:22 +08:00
index.html Merge branch 'improve-property-tooltip' into loginPage 2025-03-15 00:11:50 +08:00
package.json Merge branch 'loginPage' into webui-node-expansion 2025-03-18 00:39:48 +08:00
README.md implement API key alert 2025-02-17 01:59:36 +08:00
tsconfig.json Change to hash routing, webuiInitialize controls project prefix 2025-03-14 17:00:36 +08:00
vite.config.ts Merge branch 'improve-property-tooltip' into loginPage 2025-03-15 00:11:50 +08:00

LightRAG WebUI

LightRAG WebUI is a React-based web interface for interacting with the LightRAG system. It provides a user-friendly interface for querying, managing, and exploring LightRAG's functionalities.

Installation

  1. Install Bun:

    If you haven't already installed Bun, follow the official documentation: https://bun.sh/docs/installation

  2. Install Dependencies:

    In the lightrag_webui directory, run the following command to install project dependencies:

    bun install --frozen-lockfile
    
  3. Build the Project:

    Run the following command to build the project:

    bun run build --emptyOutDir
    

    This command will bundle the project and output the built files to the lightrag/api/webui directory.

Development

  • Start the Development Server:

    If you want to run the WebUI in development mode, use the following command:

    bun run dev
    

Script Commands

The following are some commonly used script commands defined in package.json:

  • bun install: Installs project dependencies.
  • bun run dev: Starts the development server.
  • bun run build: Builds the project.
  • bun run lint: Runs the linter.