88 lines
3.7 KiB
Markdown
88 lines
3.7 KiB
Markdown
## Codebase Structure
|
|
|
|
```markdown
|
|
## File Structure
|
|
|
|
## Root Structure
|
|
salona/
|
|
├── app/ # Android wrapper for TWA build
|
|
├── build/ # Build outputs
|
|
├── coverage/ # Test coverage reports
|
|
├── docs/ # Project documentation
|
|
├── gradle/ # Gradle configuration files
|
|
├── node_modules/ # Installed dependencies
|
|
├── public/ # Static public assets
|
|
│ ├── index.html
|
|
│ ├── firebase-scripts/ # Firebase scripts loaded locally
|
|
│ ├── lotties/ # Lottie animation files
|
|
│ ├── static-images/ # Static images used outside bundle
|
|
│ └── .well-known/
|
|
│ └── assetlinks.json # TWA configuration file
|
|
│
|
|
├── src/ # Main application source code
|
|
│
|
|
├── tests/ # Unit and integration tests
|
|
│
|
|
├── .env # Environment variables
|
|
├── Dockerfile # Docker build configuration
|
|
├── nginx.conf # Nginx configuration for production
|
|
├── package.json # Project dependencies and scripts
|
|
├── pnpm-lock.yaml # PNPM lockfile
|
|
├── tailwind.config.js # TailwindCSS configuration
|
|
├── vite.config.ts # Vite configuration
|
|
└── README.md
|
|
|
|
## Source Code Structure (src/)
|
|
|
|
src/
|
|
├── apps/
|
|
│ └── new-ui/ # New UI implementation (modular app structure)
|
|
│ ├── assets/ # App-specific assets
|
|
│ ├── components/ # UI components specific to this app
|
|
│ ├── constant/ # Constants used in the app
|
|
│ ├── data/ # Static or mock data
|
|
│ ├── hooks/ # Custom React hooks
|
|
│ ├── layouts/ # Layout wrappers
|
|
│ ├── pages/ # Page components mapped to routes
|
|
│ ├── routes/ # Route configuration
|
|
│ ├── services/ # API calls and server communication
|
|
│ └── utils/ # Utility helper functions
|
|
│
|
|
├── assets/ # Global assets (images, fonts, icons)
|
|
├── components/ # Reusable shared UI components
|
|
├── config/ # Global configuration files
|
|
├── guards/ # Route guards (auth, permissions)
|
|
├── hooks/ # Shared custom hooks
|
|
├── i18n/ # Internationalization configuration
|
|
├── lib/ # External library wrappers or helpers
|
|
├── pages/ # Top-level pages (if used globally)
|
|
├── routes/ # Main application routing setup
|
|
├── services/ # Global services and API integrations
|
|
├── utils/ # Shared utility functions
|
|
│
|
|
├── App.tsx # Root React component
|
|
├── main.tsx # Application entry point
|
|
├── firebaseConfig.ts # Firebase initialization
|
|
├── App.css # Global styles
|
|
└── index.css # Tailwind/global CSS
|
|
|
|
|
|
|
|
## 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)
|