alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #3620 from xyflow/docs-enhance

Browse Source 
READMEs for examples enhanced for better navigation of the monorepo
This commit is contained in:
Moritz Klack
2023-11-14 16:08:28 +01:00
committed by GitHub
parent 8ddf28f95a 3dad5fe9fa
commit aeb1c4132f
3 changed files with 35 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
examples/README.md Normal file
View File

@@ -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).

12
examples/react/README.md
View File

@@ -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).

12
examples/svelte/README.md
View File

@@ -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).