From 2a927bb9eac61eb1a5bbc65f7a1896f0d4d5b17e Mon Sep 17 00:00:00 2001 From: Chenlei Hu Date: Sun, 27 Oct 2024 10:12:54 -0400 Subject: [PATCH] [skip ci] Update README (Dev section) (#1334) * Expand test section * Add techstack section --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0416355f0..883381161 100644 --- a/README.md +++ b/README.md @@ -367,6 +367,14 @@ We will support custom icons later. ## Development +### Tech Stack + +- [Vue 3](https://vuejs.org/) with [TypeScript](https://www.typescriptlang.org/) +- [Pinia](https://pinia.vuejs.org/) for state management +- [PrimeVue](https://primevue.org/) with [TailwindCSS](https://tailwindcss.com/) for UI +- [Litegraph](https://github.com/Comfy-Org/litegraph.js) for node editor +- [zod](https://zod.dev/) for schema validation + ### Git pre-commit hooks Run `npm run prepare` to install Git pre-commit hooks. Currently, the pre-commit @@ -381,7 +389,7 @@ core extensions will be loaded. - Start local ComfyUI backend at `localhost:8188` - Run `npm run dev` to start the dev server -### Test +### Unit Test - `git clone https://github.com/comfyanonymous/ComfyUI_examples.git` to `tests-ui/ComfyUI_examples` or the EXAMPLE_REPO_PATH location specified in .env - `npm i` to install all dependencies @@ -389,6 +397,16 @@ core extensions will be loaded. - `npm run test:generate:examples` to extract the example workflows - `npm run test` to execute all unit tests. +### Component Test + +Component test verifies Vue components in `src/components/`. + +- `npm run test:component` to execute all component tests. + +### Playwright Test + +Playwright test verifies the whole app. See for details. + ### LiteGraph This repo is using litegraph package hosted on . Any changes to litegraph should be submitted in that repo instead. @@ -396,7 +414,6 @@ This repo is using litegraph package hosted on