Initial commit

2026-06-25 15:53:49 +03:00
commit 1bb0b7e68a
1517 changed files with 218469 additions and 0 deletions
@@ -0,0 +1,79 @@
+# Admin App Documentation
+
+The admin app is a reusable React admin panel template. It includes the app shell, layouts, shared infrastructure, built-in core modules, development tools, and generated project modules.
+
+Source root:
+
+```txt
+apps/admin/
+```
+
+Frontend architecture guide:
+
+```txt
+docs/apps-architecture/react-frontend/Readme.md
+```
+
+## Current Purpose
+
+This page is a documentation stub. The admin app will be documented in more detail while its modules are migrated or aligned to the shared React frontend architecture.
+
+For now, use this page to define ownership and the target documentation structure.
+
+## Architecture Direction
+
+`apps/admin` follows the general React architecture described in [React Frontend Architecture](../../apps-architecture/react-frontend/Readme.md).
+
+Because the admin app is a template and module host, the architecture applies at multiple levels:
+
+1. App shell architecture under `apps/admin/src/app` and `apps/admin/src/shared`.
+2. Core module architecture under `apps/admin/src/core/*`.
+3. Generated or project module architecture under `apps/admin/src/modules/*`.
+
+Large modules should be structured like small apps inside their own folder:
+
+```txt
+ModuleName/
+  config/
+  data/
+  entities/
+  providers/
+  pages/
+  shared/
+  view/
+  index.ts
+```
+
+Small modules may start with fewer folders. Add layers when the module actually owns API calls, entities, providers, pages, UI blocks, or module-only helpers.
+
+## Source Areas
+
+| Area              | Path                             | Purpose                                                                                                            |
+| ----------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| App shell         | `apps/admin/src/app/`            | App routing, providers, layouts, i18n, styles, and global configuration.                                           |
+| Infrastructure    | `apps/admin/src/infrastructure/` | HTTP, React Query helpers, storage adapters, and technical error handling shared by modules.                       |
+| Reference data    | `apps/admin/src/refdata/`        | Common API-backed datasets and option lists that are not owned by a single feature module.                         |
+| Core modules      | `apps/admin/src/core/`           | Built-in admin template modules such as File Manager, auth, account, permissions, dashboard, and admin management. |
+| Generated modules | `apps/admin/src/modules/`        | Project-specific or generated business modules.                                                                    |
+| Devtools          | `apps/admin/src/devtools/`       | Developer tools documented in the [Devtools guide](../../devtools/Readme.md).                                      |
+| Shared frontend   | `apps/admin/src/shared/`         | Admin-wide reusable UI, widgets, forms, editors, hooks, and pure utilities.                                        |
+
+## Module Documentation Plan
+
+Each core module or generated module should eventually have documentation that covers:
+
+1. Module purpose.
+2. Source path.
+3. Routes and pages.
+4. Data layer API and query ownership.
+5. Entities and DTO mapping.
+6. Providers, stores, and local state ownership.
+7. View widgets, forms, and reusable components.
+8. Backend integration, if the module has backend routes.
+9. Known migration gaps from the target architecture.
+
+## Current Module Docs
+
+| Module       | Source                             | Docs                                                                 |
+| ------------ | ---------------------------------- | -------------------------------------------------------------------- |
+| File Manager | `apps/admin/src/core/FileManager/` | [File Manager frontend](../../core-modules/file-manager/frontend.md) |