diff --git a/docs/ComponentStructure.drawio b/docs/ComponentStructure.drawio index 2fdcefc..e4ee4af 100644 --- a/docs/ComponentStructure.drawio +++ b/docs/ComponentStructure.drawio @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:59a34bc3428280ecd661efa7b4756bf9f4930f36c077984a40e7fdc6983aeeff -size 2063 +oid sha256:b8156818d0348ba0edefc52d6ed8fc84b65305c7eca275a37d3ff1733391bb1d +size 19858 diff --git a/docs/Dependencies.md b/docs/Dependencies.md index 626458e..34212ee 100644 --- a/docs/Dependencies.md +++ b/docs/Dependencies.md @@ -13,6 +13,7 @@ It depends on Vite in order to build the project. Others dependencies: - [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 diff --git a/docs/Project_Structure.md b/docs/Project_Structure.md index 890daf8..3daa579 100644 --- a/docs/Project_Structure.md +++ b/docs/Project_Structure.md @@ -4,22 +4,24 @@ The project is structured this way ``` . -├── docs Documentation folder -├── public Public folder in which the index.html +├── docs/ Documentation folder +├── public/ Public folder in which the index.html │ import its resources -├── src Source folder for the react app -│ ├── assets Assets folder in which the react app +├── src/ Source folder for the react app +│ ├── assets/ Assets folder in which the react app │ │ import its resources -│ ├── Components Components folder -│ ├── Enums Enums folder -│ ├── Interfaces Interface (+ types folder) -│ ├── test Setup folder for the tests -│ ├── tests Other tests + resources -│ ├── utils Utilities folder +│ ├── Components/ Components folder +│ ├── Enums/ Enums folder +│ ├── Events/ API Events folder +│ ├── Interfaces/ Interface (+ types folder) +│ ├── test/ Setup folder for the tests +│ ├── tests/ Other tests + resources +│ ├── utils/ Utilities folder +│ ├── workers/ Webworkers folder │ ├── index.scss Tailwind CSS extends │ ├── main.tsx Entrypoint for App injection │ └── 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 │ └── node-http.js Test server for Node.js ├── azure-pipelines.yml Azure Pipelines YAML config file