diff --git a/README.md b/README.md index efb920c04..486946f74 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # ComfyUI_frontend + Front end of ComfyUI written in TypeScript + +## 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 + +- Gradually migrate the code to TypeScript in this repo, while monitoring the change +in ComfyUI's front-end code. +- 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 + +- Run `npm install` to install the necessary packages +- Start local ComfyUI backend at `localhost:8188` +- Run `npm run dev` to start the dev server