diff --git a/README.md b/README.md index 884f41cf..088de86c 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,18 @@ graph TD Root["📁 Mavluda Beauty Repository"] Root --> backend["📁 backend"] Root --> frontend["📁 frontend"] - Root --> scripts["📁 scripts"] - Root --> _env["📄 .env"] Root --> _gitignore["📄 .gitignore"] - Root --> _gitignore_append["📄 .gitignore_append"] Root --> GEMINI_md["📄 GEMINI.md"] + Root --> SECURITY_md["📄 SECURITY.md"] Root --> generate_readmes_py["📄 generate_readmes.py"] ``` ## 📄 File Registry | File Name | Type | Responsibility | Key Aliases Used | |---|---|---|---| -| `.env` | File | Provides core logic and orchestration for .env. | N/A | | `.gitignore` | File | Provides core logic and orchestration for .gitignore. | N/A | -| `.gitignore_append` | File | Provides core logic and utilities for this domain. | N/A | | `GEMINI.md` | Markdown | Provides core logic and orchestration for GEMINI.md. | N/A | +| `SECURITY.md` | Markdown | Provides core logic and orchestration for SECURITY.md. | N/A | | `generate_readmes.py` | File | Provides core logic and orchestration for generate_readmes.py. | N/A | ## 🔗 Dependencies diff --git a/backend/README.md b/backend/README.md index 709a19b2..42698193 100644 --- a/backend/README.md +++ b/backend/README.md @@ -24,7 +24,7 @@ graph TD | File Name | Type | Responsibility | Key Aliases Used | |---|---|---|---| | `.prettierrc` | File | Provides core logic and orchestration for .prettierrc. | N/A | -| `eslint.config.mjs` | JavaScript | Provides core logic and orchestration for eslint.config.mjs. | N/A | +| `eslint.config.mjs` | JavaScript | Provides core logic and orchestration for eslint.config.mjs. | @eslint | | `nest-cli.json` | JSON Configuration | Provides core logic and orchestration for nest-cli.json. | N/A | | `package-lock.json` | JSON Configuration | Provides core logic and orchestration for package-lock.json. | N/A | | `package.json` | JSON Configuration | Provides core logic and orchestration for package.json. | N/A | @@ -32,7 +32,10 @@ graph TD | `tsconfig.json` | JSON Configuration | Provides core logic and orchestration for tsconfig.json. | N/A | ## 🔗 Dependencies -- No external dependencies. +- `@eslint/js` +- `eslint-plugin-prettier/recommended` +- `globals` +- `typescript-eslint` ## 🛠️ Usage ```typescript diff --git a/backend/src/common/README.md b/backend/src/common/README.md index 8fa98efe..a3d851f9 100644 --- a/backend/src/common/README.md +++ b/backend/src/common/README.md @@ -20,7 +20,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/README.md b/backend/src/modules/README.md index 91538132..c62afc83 100644 --- a/backend/src/modules/README.md +++ b/backend/src/modules/README.md @@ -9,7 +9,7 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 modules"] - Root --> admin-settings["📁 admin-settings"] + Root --> admin_settings["📁 admin-settings"] Root --> auth["📁 auth"] Root --> booking["📁 booking"] Root --> gallery["📁 gallery"] @@ -22,7 +22,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/admin-settings/infrastructure/README.md b/backend/src/modules/admin-settings/infrastructure/README.md index e1c84866..c0207835 100644 --- a/backend/src/modules/admin-settings/infrastructure/README.md +++ b/backend/src/modules/admin-settings/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/booking/infrastructure/README.md b/backend/src/modules/booking/infrastructure/README.md index a4d30890..c26c42a2 100644 --- a/backend/src/modules/booking/infrastructure/README.md +++ b/backend/src/modules/booking/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/gallery/infrastructure/README.md b/backend/src/modules/gallery/infrastructure/README.md index 5fe31df0..c776bee6 100644 --- a/backend/src/modules/gallery/infrastructure/README.md +++ b/backend/src/modules/gallery/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/inventory/infrastructure/README.md b/backend/src/modules/inventory/infrastructure/README.md index e14623ba..0e399f6e 100644 --- a/backend/src/modules/inventory/infrastructure/README.md +++ b/backend/src/modules/inventory/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/partnership/infrastructure/README.md b/backend/src/modules/partnership/infrastructure/README.md index e5b96009..7c85f658 100644 --- a/backend/src/modules/partnership/infrastructure/README.md +++ b/backend/src/modules/partnership/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/treatments/infrastructure/README.md b/backend/src/modules/treatments/infrastructure/README.md index 1f3c64af..05083094 100644 --- a/backend/src/modules/treatments/infrastructure/README.md +++ b/backend/src/modules/treatments/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/user/infrastructure/README.md b/backend/src/modules/user/infrastructure/README.md index 0c8fe858..c5416d11 100644 --- a/backend/src/modules/user/infrastructure/README.md +++ b/backend/src/modules/user/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/backend/src/modules/veil/infrastructure/README.md b/backend/src/modules/veil/infrastructure/README.md index c53314ee..1f34e4f8 100644 --- a/backend/src/modules/veil/infrastructure/README.md +++ b/backend/src/modules/veil/infrastructure/README.md @@ -14,7 +14,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/README.md b/frontend/README.md index 6282bdff..a2b9ffab 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -9,6 +9,7 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 frontend"] + Root --> environments["📁 environments"] Root --> public["📁 public"] Root --> src["📁 src"] Root --> angular_json["📄 angular.json"] @@ -34,10 +35,7 @@ graph TD | `tsconfig.json` | JSON Configuration | Provides core logic and orchestration for tsconfig.json. | N/A | ## 🔗 Dependencies -- `./src/app.component` -- `./src/app/app.config` -- `@angular/platform-browser` -- `leaflet/dist/leaflet.css` +- No external dependencies. ## 🛠️ Usage ```typescript diff --git a/frontend/environments/README.md b/frontend/environments/README.md new file mode 100644 index 00000000..4b173c29 --- /dev/null +++ b/frontend/environments/README.md @@ -0,0 +1,38 @@ +# 📁 environments + +[Root](/.) > [frontend](/frontend) > [environments](/frontend/environments) + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **environments** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 environments"] + Root --> environment_development_ts["📄 environment.development.ts"] + Root --> environment_en_ts["📄 environment.en.ts"] + Root --> environment_ru_ts["📄 environment.ru.ts"] + Root --> environment_tg_ts["📄 environment.tg.ts"] + Root --> environment_ts["📄 environment.ts"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `environment.development.ts` | TypeScript | Provides core logic and orchestration for environment.development.ts. | N/A | +| `environment.en.ts` | TypeScript | Provides core logic and orchestration for environment.en.ts. | N/A | +| `environment.ru.ts` | TypeScript | Provides core logic and orchestration for environment.ru.ts. | N/A | +| `environment.tg.ts` | TypeScript | Provides core logic and orchestration for environment.tg.ts. | N/A | +| `environment.ts` | TypeScript | Provides core logic and orchestration for environment.ts. | N/A | + +## 🔗 Dependencies +- `./environment.development` + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './environments'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/public/README.md b/frontend/public/README.md index 397a92c4..df0bdea3 100644 --- a/frontend/public/README.md +++ b/frontend/public/README.md @@ -13,7 +13,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/README.md b/frontend/src/README.md index 95d1aabe..0c9080d2 100644 --- a/frontend/src/README.md +++ b/frontend/src/README.md @@ -13,7 +13,6 @@ graph TD Root --> backend["📁 backend"] Root --> core["📁 core"] Root --> entities["📁 entities"] - Root --> environments["📁 environments"] Root --> features["📁 features"] Root --> locale["📁 locale"] Root --> pages["📁 pages"] @@ -42,10 +41,8 @@ graph TD - `@angular/common` - `@angular/platform-browser` - `@angular/router` -- `@pages/auth` - `@shared/services` - `@shared/ui` -- `@widgets/layouts` ## 🛠️ Usage ```typescript diff --git a/frontend/src/core/README.md b/frontend/src/core/README.md index b0fbfd4b..e7e2403b 100644 --- a/frontend/src/core/README.md +++ b/frontend/src/core/README.md @@ -15,7 +15,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/entities/README.md b/frontend/src/entities/README.md index 26b108cd..9816aa86 100644 --- a/frontend/src/entities/README.md +++ b/frontend/src/entities/README.md @@ -11,7 +11,7 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 entities"] - Root --> admin-settings["📁 admin-settings"] + Root --> admin_settings["📁 admin-settings"] Root --> gallery["📁 gallery"] Root --> treatments["📁 treatments"] Root --> user["📁 user"] @@ -19,7 +19,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/features/README.md b/frontend/src/features/README.md index 9cfa039d..ce7cd45c 100644 --- a/frontend/src/features/README.md +++ b/frontend/src/features/README.md @@ -11,15 +11,19 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 features"] - Root --> client-form["📁 client-form"] + Root --> auth["📁 auth"] + Root --> client_form["📁 client-form"] Root --> gallery["📁 gallery"] - Root --> language-selection["📁 language-selection"] + Root --> language_selection["📁 language-selection"] Root --> treatments["📁 treatments"] + Root --> user["📁 user"] Root --> veil["📁 veil"] ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/features/auth/README.md b/frontend/src/features/auth/README.md new file mode 100644 index 00000000..66483f66 --- /dev/null +++ b/frontend/src/features/auth/README.md @@ -0,0 +1,34 @@ +# 📁 auth + +[Root](/.) > [frontend](/frontend) > [src](/frontend/src) > [features](/frontend/src/features) > [auth](/frontend/src/features/auth) + +**FSD Layer:** Feature + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **auth** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 auth"] + Root --> model["📁 model"] + Root --> ui["📁 ui"] + Root --> index_ts["📄 index.ts"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | TypeScript | Provides core logic and orchestration for index.ts. | N/A | + +## 🔗 Dependencies +- No external dependencies. + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './auth'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/src/features/auth/model/README.md b/frontend/src/features/auth/model/README.md new file mode 100644 index 00000000..f50cb388 --- /dev/null +++ b/frontend/src/features/auth/model/README.md @@ -0,0 +1,32 @@ +# 📁 model + +[Root](/.) > [frontend](/frontend) > [src](/frontend/src) > [features](/frontend/src/features) > [auth](/frontend/src/features/auth) > [model](/frontend/src/features/auth/model) + +**FSD Layer:** Feature + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **model** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 model"] + Root --> auth_model_ts["📄 auth.model.ts"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `auth.model.ts` | TypeScript | Provides core logic and orchestration for auth.model.ts. | @angular | + +## 🔗 Dependencies +- `@angular/forms/signals` + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './model'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/src/features/auth/ui/README.md b/frontend/src/features/auth/ui/README.md new file mode 100644 index 00000000..30936586 --- /dev/null +++ b/frontend/src/features/auth/ui/README.md @@ -0,0 +1,33 @@ +# 📁 ui + +[Root](/.) > [frontend](/frontend) > [src](/frontend/src) > [features](/frontend/src/features) > [auth](/frontend/src/features/auth) > [ui](/frontend/src/features/auth/ui) + +**FSD Layer:** Feature + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **ui** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 ui"] + Root --> signin_form["📁 signin-form"] + Root --> signup_form["📁 signup-form"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | + +## 🔗 Dependencies +- No external dependencies. + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './ui'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/src/features/auth/ui/signin-form/README.md b/frontend/src/features/auth/ui/signin-form/README.md new file mode 100644 index 00000000..93bb743b --- /dev/null +++ b/frontend/src/features/auth/ui/signin-form/README.md @@ -0,0 +1,38 @@ +# 📁 signin-form + +[Root](/.) > [frontend](/frontend) > [src](/frontend/src) > [features](/frontend/src/features) > [auth](/frontend/src/features/auth) > [ui](/frontend/src/features/auth/ui) > [signin-form](/frontend/src/features/auth/ui/signin-form) + +**FSD Layer:** Feature + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **signin-form** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 signin-form"] + Root --> signin_form_component_html["📄 signin-form.component.html"] + Root --> signin_form_component_scss["📄 signin-form.component.scss"] + Root --> signin_form_component_ts["📄 signin-form.component.ts"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `signin-form.component.html` | HTML Template | Provides core logic and orchestration for signin-form.component.html. | N/A | +| `signin-form.component.scss` | SCSS Stylesheet | Provides core logic and orchestration for signin-form.component.scss. | N/A | +| `signin-form.component.ts` | TypeScript | Provides core logic and orchestration for signin-form.component.ts. | @angular, @features | + +## 🔗 Dependencies +- `@angular/core` +- `@angular/forms/signals` +- `@features/auth/model/auth.model` + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './signin-form'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/src/features/auth/ui/signup-form/README.md b/frontend/src/features/auth/ui/signup-form/README.md new file mode 100644 index 00000000..e0750392 --- /dev/null +++ b/frontend/src/features/auth/ui/signup-form/README.md @@ -0,0 +1,38 @@ +# 📁 signup-form + +[Root](/.) > [frontend](/frontend) > [src](/frontend/src) > [features](/frontend/src/features) > [auth](/frontend/src/features/auth) > [ui](/frontend/src/features/auth/ui) > [signup-form](/frontend/src/features/auth/ui/signup-form) + +**FSD Layer:** Feature + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **signup-form** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 signup-form"] + Root --> signup_form_component_html["📄 signup-form.component.html"] + Root --> signup_form_component_scss["📄 signup-form.component.scss"] + Root --> signup_form_component_ts["📄 signup-form.component.ts"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `signup-form.component.html` | HTML Template | Provides core logic and orchestration for signup-form.component.html. | N/A | +| `signup-form.component.scss` | SCSS Stylesheet | Provides core logic and orchestration for signup-form.component.scss. | N/A | +| `signup-form.component.ts` | TypeScript | Provides core logic and orchestration for signup-form.component.ts. | @angular, @features | + +## 🔗 Dependencies +- `@angular/core` +- `@angular/forms/signals` +- `@features/auth/model/auth.model` + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './signup-form'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/src/features/user/README.md b/frontend/src/features/user/README.md new file mode 100644 index 00000000..f297899c --- /dev/null +++ b/frontend/src/features/user/README.md @@ -0,0 +1,33 @@ +# 📁 user + +[Root](/.) > [frontend](/frontend) > [src](/frontend/src) > [features](/frontend/src/features) > [user](/frontend/src/features/user) + +**FSD Layer:** Feature + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **user** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 user"] + Root --> model["📁 model"] + Root --> index_ts["📄 index.ts"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | TypeScript | Provides core logic and orchestration for index.ts. | N/A | + +## 🔗 Dependencies +- No external dependencies. + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './user'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/src/features/user/model/README.md b/frontend/src/features/user/model/README.md new file mode 100644 index 00000000..d88b056c --- /dev/null +++ b/frontend/src/features/user/model/README.md @@ -0,0 +1,32 @@ +# 📁 model + +[Root](/.) > [frontend](/frontend) > [src](/frontend/src) > [features](/frontend/src/features) > [user](/frontend/src/features/user) > [model](/frontend/src/features/user/model) + +**FSD Layer:** Feature + +## 🎯 Purpose +Delivering luxury-tier architectural components and high-performance logic for the **model** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience. + +## 🏗️ Architecture +```mermaid +graph TD + Root["📁 model"] + Root --> users_data_ts["📄 users.data.ts"] +``` + +## 📄 File Registry +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `users.data.ts` | TypeScript | Provides core logic and orchestration for users.data.ts. | N/A | + +## 🔗 Dependencies +- No external dependencies. + +## 🛠️ Usage +```typescript +// Example usage within the Mavluda Beauty ecosystem +import { relevantMember } from './model'; + +// Integrate into the application architecture +relevantMember.execute(); +``` diff --git a/frontend/src/pages/README.md b/frontend/src/pages/README.md index a9c9c4f1..d5607e32 100644 --- a/frontend/src/pages/README.md +++ b/frontend/src/pages/README.md @@ -20,15 +20,17 @@ graph TD Root --> portfolio["📁 portfolio"] Root --> settings["📁 settings"] Root --> treatments["📁 treatments"] - Root --> treatments-catalog["📁 treatments-catalog"] - Root --> user-home["📁 user-home"] - Root --> user-profile["📁 user-profile"] + Root --> treatments_catalog["📁 treatments-catalog"] + Root --> user_home["📁 user-home"] + Root --> user_profile["📁 user-profile"] Root --> veil["📁 veil"] - Root --> veils-catalog["📁 veils-catalog"] + Root --> veils_catalog["📁 veils-catalog"] ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/pages/auth/README.md b/frontend/src/pages/auth/README.md index 6bc3927a..897b334c 100644 --- a/frontend/src/pages/auth/README.md +++ b/frontend/src/pages/auth/README.md @@ -29,6 +29,8 @@ graph TD - `@angular/common` - `@angular/router` - `@entities/user` +- `@features/auth` +- `@features/auth/model/auth.model` - `@features/language-selection` ## 🛠️ Usage diff --git a/frontend/src/pages/gallery/ui/README.md b/frontend/src/pages/gallery/ui/README.md index 665c6d7c..0baeda0d 100644 --- a/frontend/src/pages/gallery/ui/README.md +++ b/frontend/src/pages/gallery/ui/README.md @@ -11,11 +11,13 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 ui"] - Root --> gallery-form["📁 gallery-form"] + Root --> gallery_form["📁 gallery-form"] ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/pages/treatments/components/README.md b/frontend/src/pages/treatments/components/README.md index 543e0482..bcfbcc83 100644 --- a/frontend/src/pages/treatments/components/README.md +++ b/frontend/src/pages/treatments/components/README.md @@ -11,11 +11,13 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 components"] - Root --> treatment-form["📁 treatment-form"] + Root --> treatment_form["📁 treatment-form"] ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/pages/veil/ui/README.md b/frontend/src/pages/veil/ui/README.md index 38679f35..2ca467d2 100644 --- a/frontend/src/pages/veil/ui/README.md +++ b/frontend/src/pages/veil/ui/README.md @@ -11,13 +11,15 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 ui"] - Root --> veil-form["📁 veil-form"] - Root --> veil-item["📁 veil-item"] - Root --> veil-modal["📁 veil-modal"] + Root --> veil_form["📁 veil-form"] + Root --> veil_item["📁 veil-item"] + Root --> veil_modal["📁 veil-modal"] ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/shared/README.md b/frontend/src/shared/README.md index f974556a..cb71d705 100644 --- a/frontend/src/shared/README.md +++ b/frontend/src/shared/README.md @@ -20,7 +20,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/frontend/src/shared/ui/README.md b/frontend/src/shared/ui/README.md index c9b9dab1..025ee19f 100644 --- a/frontend/src/shared/ui/README.md +++ b/frontend/src/shared/ui/README.md @@ -11,10 +11,10 @@ Delivering luxury-tier architectural components and high-performance logic for t ```mermaid graph TD Root["📁 ui"] - Root --> card-view["📁 card-view"] - Root --> global-error["📁 global-error"] - Root --> image-popup["📁 image-popup"] - Root --> list-view["📁 list-view"] + Root --> card_view["📁 card-view"] + Root --> global_error["📁 global-error"] + Root --> image_popup["📁 image-popup"] + Root --> list_view["📁 list-view"] Root --> index_ts["📄 index.ts"] ``` diff --git a/frontend/src/widgets/README.md b/frontend/src/widgets/README.md index 21c51ce9..cbf5e9c4 100644 --- a/frontend/src/widgets/README.md +++ b/frontend/src/widgets/README.md @@ -17,7 +17,9 @@ graph TD ``` ## 📄 File Registry -*No relevant files in this directory.* +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| N/A | N/A | No files in this directory. | N/A | ## 🔗 Dependencies - No external dependencies. diff --git a/generate_readmes.py b/generate_readmes.py new file mode 100644 index 00000000..5743f94d --- /dev/null +++ b/generate_readmes.py @@ -0,0 +1,211 @@ +import os +import re + +IGNORE_DIRS = { + 'node_modules', 'dist', 'build', '.git', '.angular', 'tmp', 'out-tsc', + '.jules', '.agent', '.github', '.gemini', '__pycache__' +} + +FSD_LAYERS = { + 'shared': 'Shared', + 'entities': 'Entity', + 'features': 'Feature', + 'widgets': 'Widget', + 'pages': 'Page', + 'app': 'App' +} + +def get_fsd_layer(path): + parts = path.split(os.sep) + for part in reversed(parts): + if part in FSD_LAYERS: + return FSD_LAYERS[part] + return None + +def parse_existing_readme(path): + registry = {} + if not os.path.exists(path): + return registry + + with open(path, 'r', encoding='utf-8') as f: + content = f.read() + + table_match = re.search(r'## 📄 File Registry\n(.*?)(?=\n##|$)', content, re.DOTALL) + if table_match: + lines = table_match.group(1).strip().split('\n') + for line in lines: + if line.startswith('|') and not line.startswith('|---') and not line.startswith('| File Name'): + cols = [c.strip() for c in line.split('|')[1:-1]] + if len(cols) == 4: + fname = cols[0].strip('`* ') + registry[fname] = { + 'type': cols[1], + 'responsibility': cols[2], + 'aliases': cols[3] + } + return registry + +def get_file_type(filename): + ext = os.path.splitext(filename)[1].lower() + types = { + '.ts': 'TypeScript', + '.js': 'JavaScript', + '.mjs': 'JavaScript', + '.cjs': 'JavaScript', + '.json': 'JSON Configuration', + '.md': 'Markdown', + '.html': 'HTML Template', + '.css': 'CSS Stylesheet', + '.scss': 'SCSS Stylesheet', + '.py': 'Python Script', + '.yml': 'YAML Configuration', + '.yaml': 'YAML Configuration', + '.sh': 'Shell Script', + '.env': 'Environment Variables' + } + return types.get(ext, 'File') + +def extract_dependencies(filepath): + if not filepath.endswith(('.ts', '.js', '.mjs', '.cjs')): + return [] + deps = set() + try: + with open(filepath, 'r', encoding='utf-8') as f: + for line in f: + match_import = re.search(r'import\s+.*?\s+from\s+[\'"]([^\'"]+)[\'"]', line) + if match_import: + deps.add(match_import.group(1)) + match_require = re.search(r'require\([\'"]([^\'"]+)[\'"]\)', line) + if match_require: + deps.add(match_require.group(1)) + except Exception: + pass + return sorted(list(deps)) + +def get_breadcrumbs(rel_path): + if rel_path == '.': + return '[Root](/.)' + + parts = rel_path.split(os.sep) + breadcrumbs = ['[Root](/.)'] + current_path = '' + for part in parts: + current_path = f"{current_path}/{part}" + breadcrumbs.append(f"[{part}]({current_path})") + return ' > '.join(breadcrumbs) + +def generate_readme_for_dir(dirpath): + readme_path = os.path.join(dirpath, 'README.md') + existing_registry = parse_existing_readme(readme_path) + + dirname = os.path.basename(dirpath) + if dirname == '.' or dirname == '': + dirname = 'Mavluda Beauty Repository' + rel_path = '.' + else: + rel_path = os.path.relpath(dirpath, '.') + + fsd_layer = get_fsd_layer(rel_path) + + try: + entries = sorted(os.listdir(dirpath)) + except PermissionError: + return + + dirs = [] + files = [] + for e in entries: + if e in IGNORE_DIRS or e == 'README.md': + continue + full_p = os.path.join(dirpath, e) + if os.path.isdir(full_p): + dirs.append(e) + else: + files.append(e) + + breadcrumbs = get_breadcrumbs(rel_path) + + content = f"# 📁 {dirname}\n\n{breadcrumbs}\n\n" + if fsd_layer: + content += f"**FSD Layer:** {fsd_layer}\n\n" + + content += f"## 🎯 Purpose\nDelivering luxury-tier architectural components and high-performance logic for the **{dirname}** domain. This directory is a crucial part of the Mavluda Beauty full-stack ecosystem, ensuring seamless scalability, robust performance, and an elite digital experience.\n\n" + + content += "## 🏗️ Architecture\n```mermaid\ngraph TD\n" + root_node = "Root" + content += f" {root_node}[\"📁 {dirname}\"]\n" + for d in dirs: + safe_d = re.sub(r'[^a-zA-Z0-9_]', '_', d) + content += f" {root_node} --> {safe_d}[\"📁 {d}\"]\n" + for f in files: + safe_f = re.sub(r'[^a-zA-Z0-9_]', '_', f) + content += f" {root_node} --> {safe_f}[\"📄 {f}\"]\n" + content += "```\n\n" + + content += "## 📄 File Registry\n| File Name | Type | Responsibility | Key Aliases Used |\n|---|---|---|---|\n" + all_deps = set() + for f in files: + if f in existing_registry: + r = existing_registry[f] + ftype = r['type'] + resp = r['responsibility'] + aliases = r['aliases'] + else: + ftype = get_file_type(f) + resp = f"Provides core logic and orchestration for {f}." + aliases = "N/A" + + deps = extract_dependencies(os.path.join(dirpath, f)) + for d in deps: + all_deps.add(d) + if d.startswith('@'): + alias_base = d.split('/')[0] + if aliases == 'N/A': + aliases = alias_base + elif alias_base not in aliases: + aliases += f", {alias_base}" + + content += f"| `{f}` | {ftype} | {resp} | {aliases} |\n" + + if not files: + content += "| N/A | N/A | No files in this directory. | N/A |\n" + content += "\n" + + content += "## 🔗 Dependencies\n" + if all_deps: + for d in sorted(all_deps): + content += f"- `{d}`\n" + else: + content += "- No external dependencies.\n" + content += "\n" + + content += "## 🛠️ Usage\n```typescript\n// Example usage within the Mavluda Beauty ecosystem\n" + safe_import = re.sub(r'[^a-zA-Z0-9_]', '', dirname) + if not safe_import: + safe_import = "core" + content += f"import {{ relevantMember }} from './{dirname if dirname != 'Mavluda Beauty Repository' else 'core'}';\n\n" + content += "// Integrate into the application architecture\nrelevantMember.execute();\n```\n" + + with open(readme_path, 'w', encoding='utf-8') as f: + f.write(content) + +def process_directory(path): + if os.path.basename(path) in IGNORE_DIRS: + return + + generate_readme_for_dir(path) + try: + entries = os.listdir(path) + except PermissionError: + return + + for e in entries: + if e in IGNORE_DIRS: + continue + full_p = os.path.join(path, e) + if os.path.isdir(full_p): + process_directory(full_p) + +if __name__ == '__main__': + process_directory('.') + print("README generation completed.")