Siklos/svg-layout-designer-react
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update documentation
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse source
This commit is contained in:
Eric NGUYEN 2022-08-16 15:17:34 +02:00
parent 5f8e011bc6
commit 7014f520b9
3 changed files with 16 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/ComponentStructure.drawio (Stored with Git LFS)
View file

Binary file not shown.

1
docs/Dependencies.md
View file

@ -13,6 +13,7 @@ It depends on Vite in order to build the project.
Others dependencies: Others dependencies:
- [react-dom](https://reactjs.org/docs/react-dom.html): library used to inject the app to `#root` html element. - [react-dom](https://reactjs.org/docs/react-dom.html): library used to inject the app to `#root` html element.
- [react-window](https://www.npmjs.com/package/react-windows): component that offers component dynamic loading over scroll (very useful++)
- [react-svg-pan-zoom](https://www.npmjs.com/package/react-svg-pan-zoom): component that offers pan + zoom to a svg element - [react-svg-pan-zoom](https://www.npmjs.com/package/react-svg-pan-zoom): component that offers pan + zoom to a svg element

24
docs/Project_Structure.md
View file

@ -4,22 +4,24 @@ The project is structured this way
``` ```
. .
├── docs Documentation folder ├── docs/ Documentation folder
├── public Public folder in which the index.html ├── public/ Public folder in which the index.html
│ import its resources │ import its resources
├── src Source folder for the react app ├── src/ Source folder for the react app
│ ├── assets Assets folder in which the react app │ ├── assets/ Assets folder in which the react app
│ │ import its resources │ │ import its resources
│ ├── Components Components folder │ ├── Components/ Components folder
│ ├── Enums Enums folder │ ├── Enums/ Enums folder
│ ├── Interfaces Interface (+ types folder) │ ├── Events/ API Events folder
│ ├── test Setup folder for the tests │ ├── Interfaces/ Interface (+ types folder)
│ ├── tests Other tests + resources │ ├── test/ Setup folder for the tests
│ ├── utils Utilities folder │ ├── tests/ Other tests + resources
│ ├── utils/ Utilities folder
│ ├── workers/ Webworkers folder
│ ├── index.scss Tailwind CSS extends │ ├── index.scss Tailwind CSS extends
│ ├── main.tsx Entrypoint for App injection │ ├── main.tsx Entrypoint for App injection
│ └── vite-env.d.ts Types for .env files │ └── vite-env.d.ts Types for .env files
├── test-server Tests servers to test the API ├── test-server/ Tests servers to test the API
│ ├── http.js Test server for bun.sh │ ├── http.js Test server for bun.sh
│ └── node-http.js Test server for Node.js │ └── node-http.js Test server for Node.js
├── azure-pipelines.yml Azure Pipelines YAML config file ├── azure-pipelines.yml Azure Pipelines YAML config file