Skip to content

Commit 20911aa

Browse files
docs: improve README development section organization (#3929)
Co-authored-by: filtered <[email protected]>
1 parent 3a60185 commit 20911aa

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -526,11 +526,20 @@ Have another idea? Drop into Discord or open an issue, and let's chat!
526526

527527
## Development
528528

529-
### Prerequisites
530-
531-
- Node.js (v16 or later) and npm must be installed
532-
- Git for version control
533-
- A running ComfyUI backend instance
529+
### Prerequisites & Technology Stack
530+
531+
- **Required Software**:
532+
- Node.js (v16 or later) and npm
533+
- Git for version control
534+
- A running ComfyUI backend instance
535+
536+
- **Tech Stack**:
537+
- [Vue 3](https://vuejs.org/) with [TypeScript](https://www.typescriptlang.org/)
538+
- [Pinia](https://pinia.vuejs.org/) for state management
539+
- [PrimeVue](https://primevue.org/) with [TailwindCSS](https://tailwindcss.com/) for UI
540+
- [litegraph.js](https://github.com/Comfy-Org/litegraph.js) for node editor
541+
- [zod](https://zod.dev/) for schema validation
542+
- [vue-i18n](https://github.com/intlify/vue-i18n) for internationalization
534543

535544
### Initial Setup
536545

@@ -558,15 +567,6 @@ To launch ComfyUI and have it connect to your development server:
558567
python main.py --port 8188
559568
```
560569

561-
### Tech Stack
562-
563-
- [Vue 3](https://vuejs.org/) with [TypeScript](https://www.typescriptlang.org/)
564-
- [Pinia](https://pinia.vuejs.org/) for state management
565-
- [PrimeVue](https://primevue.org/) with [TailwindCSS](https://tailwindcss.com/) for UI
566-
- [litegraph.js](https://github.com/Comfy-Org/litegraph.js) for node editor
567-
- [zod](https://zod.dev/) for schema validation
568-
- [vue-i18n](https://github.com/intlify/vue-i18n) for internationalization
569-
570570
### Git pre-commit hooks
571571

572572
Run `npm run prepare` to install Git pre-commit hooks. Currently, the pre-commit
@@ -579,6 +579,7 @@ core extensions will be loaded.
579579

580580
- Start local ComfyUI backend at `localhost:8188`
581581
- Run `npm run dev` to start the dev server
582+
- Run `npm run dev:electron` to start the dev server with electron API mocked
582583

583584
#### Access dev server on touch devices
584585

0 commit comments

Comments
 (0)