Update README.md

This commit is contained in:
space-nuko
2023-05-06 00:08:17 -05:00
parent b53f6cb667
commit 89b829f36d
2 changed files with 9 additions and 9 deletions

View File

@@ -6,6 +6,14 @@ This project is *still under construction* and many features are missing, be awa
![Screenshot](./static/screenshot.png) ![Screenshot](./static/screenshot.png)
![Screenshot](./static/screenshot2.png)
## Installation
1. Download the latest release [here](https://nightly.link/space-nuko/ComfyBox/workflows/build-and-publish/master/ComfyBox-dist.zip) and extract it somewhere
2. Start the ComfyUI backend with `python main.py --enable-cors-header`
3. In the folder you extracted open the `run.bat`/`run.sh` script (requires Python 3 to be on your PATH). Alternatively you can serve the contents of the folder with a web server.
## NOTE ## NOTE
This frontend isn't compatible with regular ComfyUI's workflow format since extra metadata is saved like panel layout, so you'll have to spend a bit of time recreating them. This project also isn't compatible with regular ComfyUI's frontend extension format, but useful extensions can be integrated into this repo with some effort. This frontend isn't compatible with regular ComfyUI's workflow format since extra metadata is saved like panel layout, so you'll have to spend a bit of time recreating them. This project also isn't compatible with regular ComfyUI's frontend extension format, but useful extensions can be integrated into this repo with some effort.
@@ -18,14 +26,6 @@ This frontend isn't compatible with regular ComfyUI's workflow format since extr
- See the status of queued and finished generations and their configs in realtime - See the status of queued and finished generations and their configs in realtime
- Development with TypeScript - Development with TypeScript
## Installation
1. Download the latest release [here](https://nightly.link/space-nuko/ComfyBox/workflows/build-and-publish/master/ComfyBox-dist.zip) and extract it somewhere
2. Start the ComfyUI server with `python main.py --enable-cors-header`
3. In the folder you extracted to run `python -m http.server 8000` (or whatever web server you want)
4. Alternately extract the `.zip` into the `dist/` folder of this repository, then open `run.bat`/`run.sh`
5. Visit `http://localhost:8000` in your browser
## Development ## Development
### Requirements ### Requirements
@@ -44,5 +44,5 @@ git clone https://github.com/space-nuko/ComfyBox --recursive
2. `pnpm install` 2. `pnpm install`
4. `pnpm build:css` 4. `pnpm build:css`
5. `pnpm dev` 5. `pnpm dev`
6. Start ComfyUI as usual with `python main.py --enable-cors-header` 6. Start ComfyUI with `python main.py --enable-cors-header`
7. Visit `http://localhost:3000` in your browser 7. Visit `http://localhost:3000` in your browser

BIN
static/screenshot2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 MiB