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

Update documentation

Browse source
This commit is contained in:
Eric NGUYEN 2022-09-22 10:51:11 +02:00
parent aed79f3e08
commit 74debbf90c
2 changed files with 13 additions and 4 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.

13
docs/Project_Structure.md
View file

@ -1,12 +1,14 @@
# Project Structure # Project Structure
The project is structured this way
``` ```
. .
├── .vscode/ VSCode config folder
│ ├── launch.json VSCode debug config
│ └── settings.json VSCode project config
├── 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
│ ├── smartcomponent/ SmartComponent folder
│ └── workers/ Webworkers folder │ └── workers/ Webworkers folder
├── 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
@ -24,6 +26,13 @@ The project is structured this way
├── 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
├── .drone.yml Drone.io ci configuration
├── .env.development Vite development environment config
├── .env.production Vite production environment config
├── .env.test Vite test environment config
├── .eslintrc.cjs eslint config file
├── .gitattributes git-lfs config file
├── .gitignore git ignore config file
├── azure-pipelines.yml Azure Pipelines YAML config file ├── azure-pipelines.yml Azure Pipelines YAML config file
├── index.html HTML Page ├── index.html HTML Page
├── package-lock.json Describe the node_modules tree for npm ├── package-lock.json Describe the node_modules tree for npm