docs: update README with new Rust frontend and fix TypeScript version
- Updated README.md to reflect the addition of a native Rust frontend using egui - Added setup instructions for the new rust-frontend directory - Modified frontend package.json to downgrade TypeScript version from 5.3.3 to 4.9.5 due to conflicts - Updated path references in documentation from ComfyUI-Rust/ to direct paths - Reorganized project structure documentation to distinguish between original and new frontends
This commit is contained in:
34
README.md
34
README.md
@@ -4,7 +4,8 @@
|
||||
This project implements an AI image/video generation tool inspired by the node-based workflow editor of Stable Diffusion Web UI. Built as a modern web application using:
|
||||
|
||||
- **Backend**: Pure Rust (Actix-web framework)
|
||||
- **Frontend**: React + TypeScript with Node graph visualization
|
||||
- **Frontend**: React + TypeScript with Node graph visualization (currently having TypeScript version conflict)
|
||||
- **New Frontend Alternative**: Native Rust frontend using egui
|
||||
- **GPU Acceleration**: ROCm integration for AMD RX 9070 XT GPU
|
||||
|
||||
### Key Features:
|
||||
@@ -50,7 +51,7 @@ rocminfo # Should show your GPU info including "gfx900" or similar architectu
|
||||
### Backend Setup (Rust):
|
||||
|
||||
```bash
|
||||
cd ComfyUI-Rust/backend
|
||||
cd backend
|
||||
cargo build --release # For production builds, use release mode for better performance on AMD GPUs
|
||||
|
||||
# Run the backend server:
|
||||
@@ -60,10 +61,10 @@ Backend runs at: http://localhost:[PORT]
|
||||
API endpoints available after starting.
|
||||
```
|
||||
|
||||
### Frontend Setup (React):
|
||||
### Frontend Setup (React - currently has TypeScript conflict):
|
||||
|
||||
```bash
|
||||
cd ComfyUI-Rust/frontend
|
||||
cd frontend
|
||||
npm install # Install dependencies
|
||||
|
||||
Run dev mode with hot reload and AMD GPU preview support:
|
||||
@@ -73,6 +74,16 @@ yarn start
|
||||
RUST_AMD_ROCM_PATH=/usr/local/AMDROCmlib yarn run prod-build && npm run serve
|
||||
```
|
||||
|
||||
### New Rust Frontend Setup (egui):
|
||||
|
||||
```bash
|
||||
cd rust-frontend
|
||||
cargo run # Run the egui-based frontend
|
||||
|
||||
# Build for release:
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
## Project Structure Overview:
|
||||
|
||||
### Rust Backend (`backend/src`):
|
||||
@@ -96,7 +107,7 @@ src/
|
||||
|
||||
```
|
||||
|
||||
### Frontend Web App (`frontend/src`):
|
||||
### Original Frontend Web App (`frontend/src`):
|
||||
```typescript/react
|
||||
src/
|
||||
├─ components/node-editor.tsx // Node-based workflow editor (graph canvas)
|
||||
@@ -109,6 +120,17 @@ src/
|
||||
|
||||
```
|
||||
|
||||
### New Rust Frontend (`rust-frontend/src`):
|
||||
```rust
|
||||
src/
|
||||
├── main.rs # Main application entry point
|
||||
├── node_editor.rs # Node-based workflow editor implementation
|
||||
├── node_panel.rs # Panel for selecting and managing nodes
|
||||
├── preview_pane.rs # Preview pane for image results
|
||||
└── api_client.rs # Backend API communication layer
|
||||
|
||||
```
|
||||
|
||||
## ROCm Integration Notes:
|
||||
|
||||
### Key Components:
|
||||
@@ -116,7 +138,7 @@ src/
|
||||
- Parallelism configured based on AMD GPU thread count (RX9070XT)
|
||||
|
||||
```rust
|
||||
// Example configuration from rust/backend/src/config.rs
|
||||
// Example configuration from backend/src/config.rs
|
||||
|
||||
pub struct Config {
|
||||
pub gpu_backend_config = RocmConfig { // ROCm detection for RX900 series GPUs
|
||||
|
||||
Reference in New Issue
Block a user