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
examples/react/README.md
+11 -1
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).