update readme

configure output directory
This commit is contained in:
ArnoChen
2025-02-13 17:53:12 +08:00
parent c674905a98
commit bc83c4c7ed
5 changed files with 49 additions and 12 deletions

View File

@@ -1,12 +1,46 @@
# LightRag Graph Viewer WebUI
# LightRAG WebUI
## Install [Bun](https://bun.sh/docs/installation)
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
## Install Dependencies
1. **Install Bun:**
`bun install --frozen-lockfile`
If you haven't already installed Bun, follow the official documentation: [https://bun.sh/docs/installation](https://bun.sh/docs/installation)
## Build
2. **Install Dependencies:**
`bun run build`
In the `lightrag_webui` directory, run the following command to install project dependencies:
```bash
bun install --frozen-lockfile
```
3. **Build the Project:**
Run the following command to build the project:
```bash
bun run build
```
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:
```bash
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.

View File

@@ -2,7 +2,7 @@
"lockfileVersion": 1,
"workspaces": {
"": {
"name": "lightrag-graph-vierer-webui",
"name": "lightrag-webui",
"dependencies": {
"@faker-js/faker": "^9.4.0",
"@radix-ui/react-checkbox": "^1.1.4",

View File

@@ -1,5 +1,5 @@
{
"name": "lightrag-graph-vierer-webui",
"name": "lightrag-webui",
"private": true,
"version": "0.0.0",
"type": "module",

View File

@@ -12,5 +12,8 @@ export default defineConfig({
'@': path.resolve(__dirname, './src')
}
},
base: './'
base: './',
build: {
outDir: path.resolve(__dirname, '../lightrag/api/webui')
}
})