Files
ComfyUI_frontend/README.md
2024-06-18 21:15:57 -04:00

33 lines
1.2 KiB
Markdown

# ComfyUI_frontend
Front end of [ComfyUI](https://github.com/comfyanonymous/ComfyUI) modernized. This repo is fully compatible with existing extension system.
## The grand migration to TypeScript
This repo is an experiment trying to migrate ComfyUI's front-end code to TypeScript for a better front-end development experience.
## Tasks
- [x] Gradually migrate the code to TypeScript in this repo, while monitoring the change
in ComfyUI's front-end code.
- [ ] Using zod schema to add static/runtime type check for core structures.
- [ ] Figure out a way to reliably embed compiled code to ComfyUI distribution.
- It can be a bot regularly pulling the new changes in the front-end repo and submitting them to the main repo. (Chrome does a similar process for Chrome devtools, which is hosted in a separate repo.)
## Development
Note: You need to patch comfyanonymous/ComfyUI#3779 for the dev server to work.
- Run `npm install` to install the necessary packages
- Start local ComfyUI backend at `localhost:8188`
- Run `npm run dev` to start the dev server
## Test
- `npm run build` to build the front end
- `cd tests-ui`
- `npm i` to install all test dependencies
- `npm run test:generate` to fetch `data/object_info.json`
- `npm run test` to execute all unit tests.