Files
salona/docs/codebase-structure.md

48 lines
1.2 KiB
Markdown

## Codebase Structure
```markdown
## File Structure
project-name/
├── public/
│ ├── index.html
│ ├── firebase-scripts (To load scripts locally)
│ ├── lotties (Lottie files)
│ ├── statics-images
│ ├── .well-known/
│ │ ├── assetlinks.json (TWA config file)
│ └── ...
├── src/
│ ├── apps/
│ ├── components/
│ ├── assets/
│ ├── hooks/
│ ├── pages/
│ ├── routes/
│ ├── utils/
│ ├── App.css
│ ├── App.tsx
│ ├── main.tsx
│ └── ...
├── package.json
└── ...
```
## Source Structure
- `components/`: Reusable presentational components
- `layouts/`: Components that are layout or container or wrapper of other
components
- `hooks/`: React custom hooks
- `contexts/`: React contexts providers
- `pages/`: Project pages same as created routes
- `services/`: React query and api call hooks and functions / back-end relations
- `routes/`: Main structure of project routes
- `data/`: Static data itmes
- `assets/`: Project assests like images, videos, fonts, etc.
- `utils/`: Utility functions and helpers
---
[Go back to Readme](../README.md)