diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..df8f1670 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,13 @@ +# Examples for Testing & Development +These examples are used for feature development and E2E testing. + +## Overview +SvelteKit App with Svelte Flow examples at [`examples/svelte`](./svelte) + +Vite App with React Flow examples at [`examples/react`](./react) + +Astro App used for SSR testing at [`examples/astro-xyflow`](./astro-xyflow) + +## E2E + +For furhter documentation of E2E tests have a look at [`/tests/playwright`](/tests/playwright). \ No newline at end of file diff --git a/examples/react/README.md b/examples/react/README.md index 5a9a880c..c1207ba7 100644 --- a/examples/react/README.md +++ b/examples/react/README.md @@ -1,6 +1,6 @@ # React Flow examples -This Vite app is used internally to test the library. +This Vite app is used internally to develop and test the library. ## Start local dev server @@ -8,5 +8,15 @@ This Vite app is used internally to test the library. pnpm dev ``` +## Adding new example + +Development of the library is done against `src/examples`. Feel free to add new implementations for features that you develop. + +1. Create a new folder & flow at `src/examples/` +2. Register the new route in `src/App/routes.ts` + +## Adding new E2E implementation +E2E testing is done against the flows implemented in `src/generic-tests`. Adding a new configuration file automatically adds a new route under [`http://localhost:3000/tests/generic/$foldername/$filename`](http://localhost:5173/tests/generic/nodes/general). For further documentation visit [`xyflow/tests/playwright`](/tests/playwright). + diff --git a/examples/svelte/README.md b/examples/svelte/README.md index 72cd559c..b596832d 100644 --- a/examples/svelte/README.md +++ b/examples/svelte/README.md @@ -1,4 +1,4 @@ -# Svelte Flow examples +# Svelte Flow examples This Vite app is used internally to test the library. @@ -8,3 +8,13 @@ This Vite app is used internally to test the library. pnpm dev ``` +## Adding new example + +Development of the library is done against `src/routes/examples`. Feel free to add new implementations for features that you develop. + +1. Create a new folder & flow at `src/routes/examples/` +2. Register the new route in `src/components/Header/Header.svelte` + +## Adding new E2E implementation + +E2E testing is done against the flows implemented in `src/generic-tests`. Adding a new configuration file automatically adds a new route under [`http://localhost:5173/tests/generic/$foldername/$filename`](http://localhost:5173/tests/generic/nodes/general). For further documentation visit [`xyflow/tests/playwright`](/tests/playwright).