svg-layout-designer-react/docs/Project_Structure.md
Siklos 822cd4107d
All checks were successful
continuous-integration/drone/push Build is passing
Add some simple documentation
2022-08-08 23:07:55 +02:00

1.7 KiB

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