Update README.md

Author: hhvrc

README.md

@@ -101,6 +101,72 @@ This action is required because of cookie policy, once you have done this you sh
 
 Try closing and re-opening your development environment or console to refresh its cached system config.
 
+## 📂 Project Structure
+
+```
+.changestes/   # Versioning and changelog automation
+.github/       # GitHub workflows
+e2e/           # End-to-end tests (Playwright)
+patches/       # Manual patches to npm dependencies (used with patch-package)
+static/        # Public assets served directly (e.g., images, icons)
+src/           # Application source code
+├── lib/       # Shared modules and utilities
+│   ├── api/               # API clients
+│   │   └── internal/      # Autogenerated API client (DO NOT EDIT MANUALLY)
+│   ├── components/        # UI components
+│   │   ├── metadata/      # Meta helpers for SEO and accessibility
+│   │   ├── svg/           # Customizable SVG icons
+│   │   └── ui/            # Shadcn UI components (Do not add custom components here)
+│   ├── constants/         # Global constants
+│   ├── errorhandling/     # Error handling utilities
+│   ├── hooks/             # Svelte hooks
+│   ├── inputvalidation/   # Input validators for usage with input fields
+│   ├── signalr/           # SignalR real-time communication logic
+│   ├── stores/            # Svelte stores for global state management
+│   ├── typeguards/        # Type guard helpers for runtime type checking
+│   ├── types/             # Global TypeScript types
+│   └── utils/             # General utilities
+├── params/                # SvelteKit route parameter matchers
+├── routes/                # Application routes (file-based routing)
+│   ├── (authenticated)/   # Protected routes (everything under this folder requires authentication)
+│   │   └── +layout.svelte # Authentication boundary and layout
+│   ├── +error.svelte      # Global error fallback
+│   └── +layout.svelte     # Root layout and entrypoint
+├── app.css    # Global styles
+├── app.d.ts   # Global type declarations
+└── app.html   # HTML root template
+└── error.html # Fallback HTML error page (for critical errors)
+```
+
+## Configuration files
+
+### 📦 Node & pnpm
+
+- `.npmrc` — npm configuration.
+- `.nvmrc` — Node.js version manager file.
+- `package.json`, `pnpm-lock.yaml` — Project dependencies and lockfile.
+
+### ⚙️ Configuration & Tooling
+
+- `.editorconfig` — Editor formatting consistency across IDEs.
+- `.prettierrc`, `.prettierignore` — Code formatting rules (Prettier).
+- `eslint.config.js`, `.eslintrc`, `.eslintignore` — Linting setup (ESLint).
+- `tsconfig.json` — TypeScript compiler configuration.
+- `vite.config.ts` — Vite bundler config.
+- `svelte.config.js` — SvelteKit configuration.
+- `components.json` — Component metadata for shadcn.
+- `openapitools.json` — Codegen config from OpenAPI spec.
+- `playwright.config.ts` — End-to-end testing configuration (Playwright).
+
+### 🌐 Environment Variables
+
+- `.env`, `.env.development`, `.env.production`, `.env.test` — Environment-specific config files (e.g., API keys, endpoints).
+
+### 🐳 Containerization
+
+- `Dockerfile` — Container definition for deployment or local dev.
+- `.dockerignore` — Files to exclude from Docker build context.
+
 ## Support
 
 You can support the openshock dev team here: [Sponsor OpenShock](https://github.com/sponsors/OpenShock)