Update README.md

This commit is contained in:
Chenlei Hu
2024-06-14 20:56:38 -04:00
committed by GitHub
parent 0ef74392ca
commit 37b3e5b2a3

View File

@@ -8,15 +8,18 @@ This repo is an experiment trying to migrate ComfyUI's front-end code to TypeScr
## Tasks
- Gradually migrate the code to TypeScript in this repo, while monitoring the change
- [x] 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.
- [ ] 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
Currently the dev server does not work as the ws runs on root path '/', and all api endpoints are all defined on '/'. There might need to be some API changes before dev server can 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