LightRAG/lightrag_webui
2025-05-05 00:07:50 +08:00
..
public
src Hide created_at property on webui 2025-05-05 00:07:50 +08:00
.gitignore
.prettierrc.json
bun.lock Add typography to webui and fix markdown render problem 2025-04-22 17:21:24 +08:00
components.json
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
index.html
package.json Add typography to webui and fix markdown render problem 2025-04-22 17:21:24 +08:00
README.md
tailwind.config.js Add typography to webui and fix markdown render problem 2025-04-22 17:21:24 +08:00
tsconfig.json
vite.config.ts Fix linting 2025-04-22 18:34:30 +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.