ComfyUI_frontend  by Comfy-Org

Official ComfyUI front-end implementation

created 1 year ago
1,234 stars

Top 32.6% on sourcepulse

GitHubView on GitHub
Project Summary

This repository provides the official frontend for ComfyUI, a powerful and modular diffusion model-building interface. It targets users who want a robust, customizable, and feature-rich graphical user interface for creating complex AI workflows, offering enhanced usability and developer extensibility.

How It Works

The frontend is built using Vue 3 with TypeScript, leveraging Pinia for state management and PrimeVue with TailwindCSS for the UI. It utilizes litegraph.js for its core node-based editor functionality, enabling drag-and-drop canvas interactions, flexible node connections, and a highly interactive workflow visualization. The architecture supports extensive customization through a well-defined extension API, allowing developers to add new UI elements, commands, and integrate custom nodes seamlessly.

Quick Start & Requirements

  • Install: npm install
  • Run Dev Server: npm run dev
  • Prerequisites: Node.js (v16+), npm, Git, a running ComfyUI backend instance (defaults to localhost:8188).
  • Setup: Clone the repo, install dependencies. Configure backend port via .env file if needed.
  • Docs: Official Documentation (Link not explicitly provided in README, but implied by structure)

Highlighted Details

  • Native Localization: Supports English, Chinese (Simplified), Russian, Japanese, and Korean.
  • New Mask Editor: Introduces an integrated mask editing tool.
  • Integrated Server Terminal: Access a terminal directly within the UI (Ctrl + `).
  • Extensive Extension API: Allows for custom UI elements, commands, keybindings, and sidebar tabs.

Maintenance & Community

  • Release Schedule: Follows a structured release cycle with development, feature freeze, and publication phases for minor versions. Daily nightly releases are available.
  • Community: Active Discord server for support and discussion.
  • Links: Website, Discord, Matrix

Licensing & Compatibility

  • License: Not explicitly stated in the provided README text.

Limitations & Caveats

  • The README does not specify the project's license, which is crucial for understanding usage and distribution rights.
  • Development server does not load extensions from the ComfyUI server; only core extensions are loaded.
Health Check
Last commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
199
Issues (30d)
115
Star History
201 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.