chunzhi/comfyui-deploy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
BennyKok 2024-01-13 12:21:04 +08:00
parent f5991a1bf8
commit 76b7e8cc1a
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,9 +1,10 @@
# ComfyUI Deploy # ComfyUI Deploy
Open source comfyui deployment platform, a `vercel` for generative workflow infra.
![63shots_so 1](https://github.com/BennyKok/comfyui-deploy/assets/18395202/c0b88377-0135-4d9a-8a20-8b38b975bb48) Open source comfyui deployment platform, a `vercel` for generative workflow infra. (serverless hosted gpu with vertical intergation with comfyui)
# How it works Join [Discord](https://discord.gg/EEYcQmdYZw) to chat more or visit [Comfy Deploy](https://comfydeploy.com/) to get started!
![63shots_so 1](https://github.com/BennyKok/comfyui-deploy/assets/18395202/c0b88377-0135-4d9a-8a20-8b38b975bb48)# How it works
1. Comfy Deploy Dashboard (https://comfydeploy.com) or self-hosted version 1. Comfy Deploy Dashboard (https://comfydeploy.com) or self-hosted version
2. Machines (Long running, on-premise ComfyUI machines and serverless) 2. Machines (Long running, on-premise ComfyUI machines and serverless)
@ -22,9 +23,9 @@ https://github.com/BennyKok/comfyui-deploy/assets/18395202/0fb1829b-401a-41f2-b2
1. `cd custom_nodes` 1. `cd custom_nodes`
2. `git clone https://github.com/BennyKok/comfyui-deploy.git` 2. `git clone https://github.com/BennyKok/comfyui-deploy.git`
3. Go to (https://comfydeploy.com) or a self-hosted version 3. Go to (https://comfydeploy.com) or a self-hosted version
- Machines -> Add Machines - Machines -> Add Machines
- Enter a name and the URL of your machines (set up Ngrok for a public URL for your machines) - Enter a name and the URL of your machines (set up Ngrok for a public URL for your machines)
- Create a new ComfyDeploy machines (pick any custom nodes). - Create a new ComfyDeploy machines (pick any custom nodes).
# Usecase # Usecase
@ -33,15 +34,14 @@ https://github.com/BennyKok/comfyui-deploy/assets/18395202/0fb1829b-401a-41f2-b2
3. Persistent API generated for Production and Staging environment 3. Persistent API generated for Production and Staging environment
4. Run the same comfyui workflow across different remote machines 4. Run the same comfyui workflow across different remote machines
![467shots_so 1](https://github.com/BennyKok/comfyui-deploy/assets/18395202/e49a0360-de94-4e3b-802b-0eadabe3c166) ![467shots_so 1](https://github.com/BennyKok/comfyui-deploy/assets/18395202/e49a0360-de94-4e3b-802b-0eadabe3c166)# Status & Timeline
# Status & Timeline WIP, welcomes contributors!! Please join Discord -> https://discord.gg/EEYcQmdYZw
WIP, welcomes contributors!! Please join Discord -> https://discord.gg/EEYcQmdYZw Primary goal -> release v0.1.0 of stable Comfy Deploy
Primary goal -> release v0.1.0 of stable Comfy Deploy
Major areas Major areas
- Security enforcement - Security enforcement
- Error handling - Error handling
- QOL workflow improvement - QOL workflow improvement
@ -53,12 +53,17 @@ Major areas
- LCM realtime web socket image gen - LCM realtime web socket image gen
# Tech Stack # Tech Stack
- Shadcn UI - Shadcn UI
- NextJS - NextJS
- Clerk (Auth) - Clerk (Auth)
- Neon / Vercel Postgres (Database) - Neon / Vercel Postgres (Database)
- Drizzle (ORM) - Drizzle (ORM)
- R2 / S3 (Object Storage) - R2 / S3 (Object Storage)
# Development # Development
@ -74,10 +79,11 @@ Major areas
9. Finally start the next server with `bun dev` 9. Finally start the next server with `bun dev`
**Schema Changes** **Schema Changes**
1. `bun run generate` 1. `bun run generate`
2. `bun run migrate-local` 2. `bun run migrate-local`
# Special Thanks # Special Thanks
- comfyui - comfyui
- oss/acc - oss/acc