Add some simple documentation
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
bcf84b1f39
commit
822cd4107d
2 changed files with 111 additions and 0 deletions
38
docs/Project_Structure.md
Normal file
38
docs/Project_Structure.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# Project Structure
|
||||
|
||||
The project is structured this way
|
||||
|
||||
```
|
||||
.
|
||||
├── 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
|
||||
│ │ 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
|
||||
│ ├── 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
|
||||
│ ├── http.js Test server for bun.sh
|
||||
│ └── node-http.js Test server for Node.js
|
||||
├── azure-pipelines.yml Azure Pipelines YAML config file
|
||||
├── index.html HTML Page
|
||||
├── package-lock.json Describe the node_modules tree for npm
|
||||
├── package.json Node.JS config file
|
||||
├── pnpm-lock.yaml Describe the node_modules tree for pnpm
|
||||
├── postcss.config.cjs Postcss config file for SCSS processing
|
||||
├── README.md
|
||||
├── tailwind.config.cjs Tailwind CSS config file
|
||||
├── tsconfig.json Typescript config file
|
||||
├── tsconfig.node.json Typescript config file for Node modules
|
||||
├── vite.config.ts Vite config file
|
||||
└── vitest.config.ts Vitest config file
|
||||
```
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue