https://github.com/litegraphdb/ui
LiteGraph web user interface
https://github.com/litegraphdb/ui
Last synced: over 1 year ago
JSON representation
LiteGraph web user interface
- Host: GitHub
- URL: https://github.com/litegraphdb/ui
- Owner: litegraphdb
- Created: 2025-03-11T16:53:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-12T09:01:44.000Z (over 1 year ago)
- Last Synced: 2025-03-12T09:37:06.609Z (over 1 year ago)
- Language: TypeScript
- Size: 352 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LiteGraph Web UI
A web interface for visualizing and managing network graphs, built with Next.js and React.
## Features
Tenant Dashboard
This can be accessed by logging in to `localhost:3000/login`
- **Home**: Main graph visualization interface
- **Graphs**: Manage and edit graph definitions
- **Nodes**: View and edit graph nodes
- **Edges**: Manage connections between nodes
- **Labels**: Manage and edit labels
- **Tags**: Manage and edit tags
- **Vectors**: Manage and edit vectors
Admin Dashboard
This can be accessed by logging in to `localhost:3000/login/admin`
- **Tenants**: Manage and edit tenants
- **Users**: Manage and edit users
- **Credentials**: Manage and edit credentials
## Requirements
- Node.js v18.20.4
- npm
## Quick Start
### Development Setup
#### Install dependencies:
```bash
npm install
```
#### Set the liteGraph instance URL
Update the `liteGraphInstanceURL` in [`constants/config.ts`](constants/config.ts) to point to your litegraph instance:
```typescript
export const liteGraphInstanceURL = 'http://localhost:3000';
```
#### Start the production server (for using web ui locally):
```bash
npm run build
```
```bash
npm run start
```
OR
#### Start the development server (for development, can be used to test web ui locally as well):
```bash
npm run dev
```
The application will be available at `http://localhost:3000`.
### Testing
Run the test suite:
```bash
# Run all tests
npm test
# Run tests with coverage
npm run test:coverage
# Watch mode for development
npm run test:watch
```
## Deployment Process
#### Build the Application
Prepare the app for production:
```bash
npm run build
```
#### Start the Production Server
Start the built application:
```bash
npm run start
```
The app will be available at http://localhost:3000.
### Code Quality
The project uses several tools to maintain code quality:
- ESLint for code linting
- Prettier for code formatting
- Jest for testing
- Husky for pre-commit hooks
## Development Guidelines
1. **Code Style**
- Follow the Prettier configuration
- Use TypeScript for type safety
- Follow component-based architecture
2. **Testing**
- Write unit tests for components