diff --git a/.gitignore b/.gitignore index 15611136..6a55c113 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,7 @@ dist-ssr *.njsproj *.sln *.sw? +*.md +!README.md +!GEMINI.md +!AGENTS.md diff --git a/.gitignore_append b/.gitignore_append new file mode 100644 index 00000000..650411d6 --- /dev/null +++ b/.gitignore_append @@ -0,0 +1,4 @@ +*.md +!README.md +!GEMINI.md +!AGENTS.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..39bb2b0a --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# [root](/) + +## 🏷️ πŸ“ Root + +### 🎯 PURPOSE +The `root` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the root logic to ensure a seamless and premium experience. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + root[πŸ“ root] + root --> backend[πŸ“ backend] + root --> frontend[πŸ“ frontend] + root --> _env(.env) + root --> _gitignore(.gitignore) + root --> GEMINI_md(GEMINI.md) + root --> generate_all_readmes_py(generate_all_readmes.py) + root --> generate_all_readmes_refined_py(generate_all_readmes_refined.py) + root --> generate_readme_py(generate_readme.py) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `.env` | `env` | Configuration and foundational asset. | None | +| `.gitignore` | `gitignore` | Configuration and foundational asset. | None | +| `GEMINI.md` | `md` | Configuration and foundational asset. | None | +| `generate_all_readmes.py` | `py` | Configuration and foundational asset. | None | +| `generate_all_readmes_refined.py` | `py` | Configuration and foundational asset. | None | +| `generate_readme.py` | `py` | Configuration and foundational asset. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate root into your refined workflows: +import { /* exported members */ } from '@path/to/root'; +``` diff --git a/backend/README.md b/backend/README.md index 8f0f65f7..a6aeb5f5 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,98 +1,42 @@ -

- Nest Logo -

- -[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 -[circleci-url]: https://circleci.com/gh/nestjs/nest - -

A progressive Node.js framework for building efficient and scalable server-side applications.

-

-NPM Version -Package License -NPM Downloads -CircleCI -Discord -Backers on Open Collective -Sponsors on Open Collective - Donate us - Support us - Follow us on Twitter -

- - -## Description - -[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. - -## Project setup - -```bash -$ npm install +# [backend](/backend) + +## 🏷️ πŸ“ Backend + +### 🎯 PURPOSE +The `backend` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the backend logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + backend[πŸ“ backend] + backend --> src[πŸ“ src] + backend --> test[πŸ“ test] + backend --> _prettierrc(.prettierrc) + backend --> eslint_config_mjs(eslint.config.mjs) + backend --> nest_cli_json(nest-cli.json) + backend --> package_lock_json(package-lock.json) + backend --> package_json(package.json) + backend --> tsconfig_build_json(tsconfig.build.json) + backend --> tsconfig_json(tsconfig.json) ``` -## Compile and run the project - -```bash -# development -$ npm run start - -# watch mode -$ npm run start:dev - -# production mode -$ npm run start:prod +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `.prettierrc` | `prettierrc` | Configuration and foundational asset. | None | +| `eslint.config.mjs` | `mjs` | Configuration and foundational asset. | None | +| `nest-cli.json` | `json` | Configuration and foundational asset. | None | +| `package-lock.json` | `json` | Configuration and foundational asset. | None | +| `package.json` | `json` | Configuration and foundational asset. | None | +| `tsconfig.build.json` | `json` | Configuration and foundational asset. | None | +| `tsconfig.json` | `json` | Configuration and foundational asset. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate backend into your refined workflows: +import { /* exported members */ } from '@path/to/backend'; ``` - -## Run tests - -```bash -# unit tests -$ npm run test - -# e2e tests -$ npm run test:e2e - -# test coverage -$ npm run test:cov -``` - -## Deployment - -When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information. - -If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps: - -```bash -$ npm install -g @nestjs/mau -$ mau deploy -``` - -With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure. - -## Resources - -Check out a few resources that may come in handy when working with NestJS: - -- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. -- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). -- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). -- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. -- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). -- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). -- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). -- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). - -## Support - -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). - -## Stay in touch - -- Author - [Kamil MyΕ›liwiec](https://twitter.com/kammysliwiec) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) - -## License - -Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE). diff --git a/backend/src/README.md b/backend/src/README.md new file mode 100644 index 00000000..c83ec4d9 --- /dev/null +++ b/backend/src/README.md @@ -0,0 +1,52 @@ +# [backend](/backend) / [src](/backend/src) + +## 🏷️ πŸ“ Src + +### 🎯 PURPOSE +The `src` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the src logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + src[πŸ“ src] + src --> common[πŸ“ common] + src --> modules[πŸ“¦ modules] + src --> app_controller_spec_ts(app.controller.spec.ts) + src --> app_controller_ts(app.controller.ts) + src --> app_module_ts(app.module.ts) + src --> app_service_ts(app.service.ts) + src --> main_ts(main.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `app.controller.spec.ts` | `ts` | Encapsulates premium logic and definitions for `app.controller.spec.ts`. | @nestjs/testing | +| `app.controller.ts` | `ts` | Encapsulates premium logic and definitions for `app.controller.ts`. | @nestjs/common | +| `app.module.ts` | `ts` | Encapsulates premium logic and definitions for `app.module.ts`. | @modules/veil, @modules/booking, @modules/admin-settings, @nestjs/common, @modules/inventory, @modules/auth, @modules/treatments, @modules/user, @modules/gallery, @modules/partnership, @nestjs/serve-static, @modules/payment | +| `app.service.ts` | `ts` | Encapsulates premium logic and definitions for `app.service.ts`. | @nestjs/common | +| `main.ts` | `ts` | Encapsulates premium logic and definitions for `main.ts`. | @nestjs/config, @nestjs/common, @nestjs/core | + + +### πŸ”— DEPENDENCIES +- `@modules/admin-settings` +- `@modules/auth` +- `@modules/booking` +- `@modules/gallery` +- `@modules/inventory` +- `@modules/partnership` +- `@modules/payment` +- `@modules/treatments` +- `@modules/user` +- `@modules/veil` +- `@nestjs/common` +- `@nestjs/config` +- `@nestjs/core` +- `@nestjs/serve-static` +- `@nestjs/testing` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate src into your refined workflows: +import { /* exported members */ } from '@path/to/src'; +``` diff --git a/backend/src/common/README.md b/backend/src/common/README.md new file mode 100644 index 00000000..c697dfe4 --- /dev/null +++ b/backend/src/common/README.md @@ -0,0 +1,33 @@ +# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) + +## 🏷️ πŸ“ Common + +### 🎯 PURPOSE +The `common` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the common logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + common[πŸ“ common] + common --> config[πŸ› οΈ config] + common --> database[πŸ’Ύ database] + common --> decorators[✨ decorators] + common --> guards[πŸ›‘οΈ guards] + common --> interfaces[πŸ”Œ interfaces] + common --> utils[🧰 utils] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate common into your refined workflows: +import { /* exported members */ } from '@path/to/common'; +``` diff --git a/backend/src/common/config/README.md b/backend/src/common/config/README.md new file mode 100644 index 00000000..68a4421a --- /dev/null +++ b/backend/src/common/config/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [config](/backend/src/common/config) + +## 🏷️ πŸ› οΈ Config + +### 🎯 PURPOSE +The `config` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the config logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + config[πŸ› οΈ config] + config --> app_config_module_ts(app-config.module.ts) + config --> app_config_service_ts(app-config.service.ts) + config --> configuration_ts(configuration.ts) + config --> env_validation_ts(env.validation.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `app-config.module.ts` | `ts` | Encapsulates premium logic and definitions for `app-config.module.ts`. | @nestjs/config, @nestjs/common | +| `app-config.service.ts` | `ts` | Encapsulates premium logic and definitions for `app-config.service.ts`. | @nestjs/config, @nestjs/common | +| `configuration.ts` | `ts` | Encapsulates premium logic and definitions for `configuration.ts`. | None | +| `env.validation.ts` | `ts` | Encapsulates premium logic and definitions for `env.validation.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/config` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate config into your refined workflows: +import { /* exported members */ } from '@path/to/config'; +``` diff --git a/backend/src/common/database/README.md b/backend/src/common/database/README.md new file mode 100644 index 00000000..fd43f3c1 --- /dev/null +++ b/backend/src/common/database/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [database](/backend/src/common/database) + +## 🏷️ πŸ’Ύ Database + +### 🎯 PURPOSE +The `database` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the database logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + database[πŸ’Ύ database] + database --> database_module_ts(database.module.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `database.module.ts` | `ts` | Encapsulates premium logic and definitions for `database.module.ts`. | @nestjs/config, @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/config` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate database into your refined workflows: +import { /* exported members */ } from '@path/to/database'; +``` diff --git a/backend/src/common/decorators/README.md b/backend/src/common/decorators/README.md new file mode 100644 index 00000000..ccb34bea --- /dev/null +++ b/backend/src/common/decorators/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [decorators](/backend/src/common/decorators) + +## 🏷️ ✨ Decorators + +### 🎯 PURPOSE +The `decorators` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the decorators logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + decorators[✨ decorators] + decorators --> public_decorator_ts(public.decorator.ts) + decorators --> roles_decorator_ts(roles.decorator.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `public.decorator.ts` | `ts` | Encapsulates premium logic and definitions for `public.decorator.ts`. | @nestjs/common | +| `roles.decorator.ts` | `ts` | Encapsulates premium logic and definitions for `roles.decorator.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate decorators into your refined workflows: +import { /* exported members */ } from '@path/to/decorators'; +``` diff --git a/backend/src/common/guards/README.md b/backend/src/common/guards/README.md new file mode 100644 index 00000000..d5e2dceb --- /dev/null +++ b/backend/src/common/guards/README.md @@ -0,0 +1,32 @@ +# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [guards](/backend/src/common/guards) + +## 🏷️ πŸ›‘οΈ Guards + +### 🎯 PURPOSE +The `guards` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the guards logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + guards[πŸ›‘οΈ guards] + guards --> jwt_auth_guard_ts(jwt-auth.guard.ts) + guards --> roles_guard_ts(roles.guard.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `jwt-auth.guard.ts` | `ts` | Encapsulates premium logic and definitions for `jwt-auth.guard.ts`. | @nestjs/passport, @nestjs/common, @nestjs/core | +| `roles.guard.ts` | `ts` | Encapsulates premium logic and definitions for `roles.guard.ts`. | @nestjs/common, @nestjs/core | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/core` +- `@nestjs/passport` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate guards into your refined workflows: +import { /* exported members */ } from '@path/to/guards'; +``` diff --git a/backend/src/common/interfaces/README.md b/backend/src/common/interfaces/README.md new file mode 100644 index 00000000..8d9eab74 --- /dev/null +++ b/backend/src/common/interfaces/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [interfaces](/backend/src/common/interfaces) + +## 🏷️ πŸ”Œ Interfaces + +### 🎯 PURPOSE +The `interfaces` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the interfaces logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + interfaces[πŸ”Œ interfaces] + interfaces --> authenticated_request_interface_ts(authenticated-request.interface.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `authenticated-request.interface.ts` | `ts` | Encapsulates premium logic and definitions for `authenticated-request.interface.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate interfaces into your refined workflows: +import { /* exported members */ } from '@path/to/interfaces'; +``` diff --git a/backend/src/common/utils/README.md b/backend/src/common/utils/README.md new file mode 100644 index 00000000..77a4b1f3 --- /dev/null +++ b/backend/src/common/utils/README.md @@ -0,0 +1,32 @@ +# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [utils](/backend/src/common/utils) + +## 🏷️ 🧰 Utils + +### 🎯 PURPOSE +The `utils` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the utils logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + utils[🧰 utils] + utils --> file_system_ts(file-system.ts) + utils --> index_ts(index.ts) + utils --> object_ts(object.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `file-system.ts` | `ts` | Encapsulates premium logic and definitions for `file-system.ts`. | None | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `object.ts` | `ts` | Encapsulates premium logic and definitions for `object.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate utils into your refined workflows: +import { /* exported members */ } from '@path/to/utils'; +``` diff --git a/backend/src/modules/README.md b/backend/src/modules/README.md new file mode 100644 index 00000000..027ea3ca --- /dev/null +++ b/backend/src/modules/README.md @@ -0,0 +1,37 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) + +## 🏷️ πŸ“¦ Modules + +### 🎯 PURPOSE +The `modules` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the modules logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + modules[πŸ“¦ modules] + modules --> admin-settings[πŸ“ admin-settings] + modules --> auth[πŸ“ auth] + modules --> booking[πŸ“ booking] + modules --> gallery[πŸ“ gallery] + modules --> inventory[πŸ“ inventory] + modules --> partnership[πŸ“ partnership] + modules --> payment[πŸ“ payment] + modules --> treatments[πŸ“ treatments] + modules --> user[πŸ“ user] + modules --> veil[πŸ“ veil] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate modules into your refined workflows: +import { /* exported members */ } from '@path/to/modules'; +``` diff --git a/backend/src/modules/admin-settings/README.md b/backend/src/modules/admin-settings/README.md new file mode 100644 index 00000000..5031f3db --- /dev/null +++ b/backend/src/modules/admin-settings/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) + +## 🏷️ πŸ“ Admin-settings + +### 🎯 PURPOSE +The `admin-settings` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the admin-settings logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + admin-settings[πŸ“ admin-settings] + admin-settings --> application[πŸš€ application] + admin-settings --> domain[πŸ›οΈ domain] + admin-settings --> infrastructure[πŸ—οΈ infrastructure] + admin-settings --> presentation[🎨 presentation] + admin-settings --> admin_settings_module_ts(admin-settings.module.ts) + admin-settings --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.module.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.module.ts`. | @nestjs/common, @nestjs/mongoose | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate admin-settings into your refined workflows: +import { /* exported members */ } from '@path/to/admin-settings'; +``` diff --git a/backend/src/modules/admin-settings/application/README.md b/backend/src/modules/admin-settings/application/README.md new file mode 100644 index 00000000..d972a043 --- /dev/null +++ b/backend/src/modules/admin-settings/application/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [application](/backend/src/modules/admin-settings/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> admin_settings_service_ts(admin-settings.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.service.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/admin-settings/domain/README.md b/backend/src/modules/admin-settings/domain/README.md new file mode 100644 index 00000000..4018eddc --- /dev/null +++ b/backend/src/modules/admin-settings/domain/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [domain](/backend/src/modules/admin-settings/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> interfaces[πŸ”Œ interfaces] + domain --> admin_settings_entity_ts(admin-settings.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.entity.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/admin-settings/domain/interfaces/README.md b/backend/src/modules/admin-settings/domain/interfaces/README.md new file mode 100644 index 00000000..a577e3c9 --- /dev/null +++ b/backend/src/modules/admin-settings/domain/interfaces/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [domain](/backend/src/modules/admin-settings/domain) / [interfaces](/backend/src/modules/admin-settings/domain/interfaces) + +## 🏷️ πŸ”Œ Interfaces + +### 🎯 PURPOSE +The `interfaces` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the interfaces logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + interfaces[πŸ”Œ interfaces] + interfaces --> admin_settings_interface_ts(admin-settings.interface.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.interface.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.interface.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate interfaces into your refined workflows: +import { /* exported members */ } from '@path/to/interfaces'; +``` diff --git a/backend/src/modules/admin-settings/infrastructure/README.md b/backend/src/modules/admin-settings/infrastructure/README.md new file mode 100644 index 00000000..eb8be3bf --- /dev/null +++ b/backend/src/modules/admin-settings/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [infrastructure](/backend/src/modules/admin-settings/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/admin-settings/infrastructure/repositories/README.md b/backend/src/modules/admin-settings/infrastructure/repositories/README.md new file mode 100644 index 00000000..ace35384 --- /dev/null +++ b/backend/src/modules/admin-settings/infrastructure/repositories/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [infrastructure](/backend/src/modules/admin-settings/infrastructure) / [repositories](/backend/src/modules/admin-settings/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> admin_settings_repository_ts(admin-settings.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.repository.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.repository.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/admin-settings/infrastructure/schemas/README.md b/backend/src/modules/admin-settings/infrastructure/schemas/README.md new file mode 100644 index 00000000..36532c60 --- /dev/null +++ b/backend/src/modules/admin-settings/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [infrastructure](/backend/src/modules/admin-settings/infrastructure) / [schemas](/backend/src/modules/admin-settings/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> admin_settings_schema_ts(admin-settings.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.schema.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/admin-settings/presentation/README.md b/backend/src/modules/admin-settings/presentation/README.md new file mode 100644 index 00000000..94a5364a --- /dev/null +++ b/backend/src/modules/admin-settings/presentation/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [presentation](/backend/src/modules/admin-settings/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> admin_settings_controller_ts(admin-settings.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.controller.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.controller.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/admin-settings/presentation/dto/README.md b/backend/src/modules/admin-settings/presentation/dto/README.md new file mode 100644 index 00000000..727a974c --- /dev/null +++ b/backend/src/modules/admin-settings/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [admin-settings](/backend/src/modules/admin-settings) / [presentation](/backend/src/modules/admin-settings/presentation) / [dto](/backend/src/modules/admin-settings/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_admin_settings_dto_ts(create-admin-settings.dto.ts) + dto --> update_admin_settings_dto_ts(update-admin-settings.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-admin-settings.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-admin-settings.dto.ts`. | None | +| `update-admin-settings.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-admin-settings.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/auth/README.md b/backend/src/modules/auth/README.md new file mode 100644 index 00000000..c4c166b0 --- /dev/null +++ b/backend/src/modules/auth/README.md @@ -0,0 +1,45 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [auth](/backend/src/modules/auth) + +## 🏷️ πŸ“ Auth + +### 🎯 PURPOSE +The `auth` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the auth logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + auth[πŸ“ auth] + auth --> dto[πŸ“¨ dto] + auth --> infrastructure[πŸ—οΈ infrastructure] + auth --> interfaces[πŸ”Œ interfaces] + auth --> auth_controller_ts(auth.controller.ts) + auth --> auth_module_ts(auth.module.ts) + auth --> auth_service_ts(auth.service.ts) + auth --> index_ts(index.ts) + auth --> telegram_auth_service_ts(telegram-auth.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `auth.controller.ts` | `ts` | Encapsulates premium logic and definitions for `auth.controller.ts`. | @common/decorators/public.decorator, @nestjs/common | +| `auth.module.ts` | `ts` | Encapsulates premium logic and definitions for `auth.module.ts`. | @nestjs/jwt, @nestjs/passport, @common/config/app-config.service, @nestjs/common, @modules/user, @common/config/app-config.module | +| `auth.service.ts` | `ts` | Encapsulates premium logic and definitions for `auth.service.ts`. | @nestjs/jwt, @modules/user, @nestjs/common | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `telegram-auth.service.ts` | `ts` | Encapsulates premium logic and definitions for `telegram-auth.service.ts`. | @common/config/app-config.service, @modules/user, @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@common/config/app-config.module` +- `@common/config/app-config.service` +- `@common/decorators/public.decorator` +- `@modules/user` +- `@nestjs/common` +- `@nestjs/jwt` +- `@nestjs/passport` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate auth into your refined workflows: +import { /* exported members */ } from '@path/to/auth'; +``` diff --git a/backend/src/modules/auth/dto/README.md b/backend/src/modules/auth/dto/README.md new file mode 100644 index 00000000..00511bc2 --- /dev/null +++ b/backend/src/modules/auth/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [auth](/backend/src/modules/auth) / [dto](/backend/src/modules/auth/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> login_dto_ts(login.dto.ts) + dto --> register_dto_ts(register.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `login.dto.ts` | `ts` | Encapsulates premium logic and definitions for `login.dto.ts`. | None | +| `register.dto.ts` | `ts` | Encapsulates premium logic and definitions for `register.dto.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/auth/infrastructure/README.md b/backend/src/modules/auth/infrastructure/README.md new file mode 100644 index 00000000..bff9a49a --- /dev/null +++ b/backend/src/modules/auth/infrastructure/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [auth](/backend/src/modules/auth) / [infrastructure](/backend/src/modules/auth/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> jwt_strategy_ts(jwt.strategy.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `jwt.strategy.ts` | `ts` | Encapsulates premium logic and definitions for `jwt.strategy.ts`. | @nestjs/passport, @nestjs/common, @common/config/app-config.service | + + +### πŸ”— DEPENDENCIES +- `@common/config/app-config.service` +- `@nestjs/common` +- `@nestjs/passport` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/auth/interfaces/README.md b/backend/src/modules/auth/interfaces/README.md new file mode 100644 index 00000000..d664ef01 --- /dev/null +++ b/backend/src/modules/auth/interfaces/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [auth](/backend/src/modules/auth) / [interfaces](/backend/src/modules/auth/interfaces) + +## 🏷️ πŸ”Œ Interfaces + +### 🎯 PURPOSE +The `interfaces` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the interfaces logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + interfaces[πŸ”Œ interfaces] + interfaces --> auth_response_interface_ts(auth-response.interface.ts) + interfaces --> jwt_payload_interface_ts(jwt-payload.interface.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `auth-response.interface.ts` | `ts` | Encapsulates premium logic and definitions for `auth-response.interface.ts`. | @modules/user | +| `jwt-payload.interface.ts` | `ts` | Encapsulates premium logic and definitions for `jwt-payload.interface.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@modules/user` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate interfaces into your refined workflows: +import { /* exported members */ } from '@path/to/interfaces'; +``` diff --git a/backend/src/modules/booking/README.md b/backend/src/modules/booking/README.md new file mode 100644 index 00000000..68a748c0 --- /dev/null +++ b/backend/src/modules/booking/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) + +## 🏷️ πŸ“ Booking + +### 🎯 PURPOSE +The `booking` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the booking logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + booking[πŸ“ booking] + booking --> application[πŸš€ application] + booking --> domain[πŸ›οΈ domain] + booking --> infrastructure[πŸ—οΈ infrastructure] + booking --> presentation[🎨 presentation] + booking --> booking_module_ts(booking.module.ts) + booking --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `booking.module.ts` | `ts` | Encapsulates premium logic and definitions for `booking.module.ts`. | @nestjs/common, @nestjs/mongoose | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate booking into your refined workflows: +import { /* exported members */ } from '@path/to/booking'; +``` diff --git a/backend/src/modules/booking/application/README.md b/backend/src/modules/booking/application/README.md new file mode 100644 index 00000000..0f7dbc51 --- /dev/null +++ b/backend/src/modules/booking/application/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) / [application](/backend/src/modules/booking/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> booking_service_ts(booking.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `booking.service.ts` | `ts` | Encapsulates premium logic and definitions for `booking.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/booking/domain/README.md b/backend/src/modules/booking/domain/README.md new file mode 100644 index 00000000..9cb7df6c --- /dev/null +++ b/backend/src/modules/booking/domain/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) / [domain](/backend/src/modules/booking/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> booking_entity_ts(booking.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `booking.entity.ts` | `ts` | Encapsulates premium logic and definitions for `booking.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/booking/infrastructure/README.md b/backend/src/modules/booking/infrastructure/README.md new file mode 100644 index 00000000..393de390 --- /dev/null +++ b/backend/src/modules/booking/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) / [infrastructure](/backend/src/modules/booking/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/booking/infrastructure/repositories/README.md b/backend/src/modules/booking/infrastructure/repositories/README.md new file mode 100644 index 00000000..ccd068e8 --- /dev/null +++ b/backend/src/modules/booking/infrastructure/repositories/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) / [infrastructure](/backend/src/modules/booking/infrastructure) / [repositories](/backend/src/modules/booking/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> booking_repository_ts(booking.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `booking.repository.ts` | `ts` | Encapsulates premium logic and definitions for `booking.repository.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/booking/infrastructure/schemas/README.md b/backend/src/modules/booking/infrastructure/schemas/README.md new file mode 100644 index 00000000..699c4bf7 --- /dev/null +++ b/backend/src/modules/booking/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) / [infrastructure](/backend/src/modules/booking/infrastructure) / [schemas](/backend/src/modules/booking/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> booking_schema_ts(booking.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `booking.schema.ts` | `ts` | Encapsulates premium logic and definitions for `booking.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/booking/presentation/README.md b/backend/src/modules/booking/presentation/README.md new file mode 100644 index 00000000..0dcbf73a --- /dev/null +++ b/backend/src/modules/booking/presentation/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) / [presentation](/backend/src/modules/booking/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> booking_controller_ts(booking.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `booking.controller.ts` | `ts` | Encapsulates premium logic and definitions for `booking.controller.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/booking/presentation/dto/README.md b/backend/src/modules/booking/presentation/dto/README.md new file mode 100644 index 00000000..78f2e9eb --- /dev/null +++ b/backend/src/modules/booking/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [booking](/backend/src/modules/booking) / [presentation](/backend/src/modules/booking/presentation) / [dto](/backend/src/modules/booking/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_booking_dto_ts(create-booking.dto.ts) + dto --> update_booking_dto_ts(update-booking.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-booking.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-booking.dto.ts`. | None | +| `update-booking.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-booking.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/gallery/README.md b/backend/src/modules/gallery/README.md new file mode 100644 index 00000000..e71bfbb1 --- /dev/null +++ b/backend/src/modules/gallery/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) + +## 🏷️ πŸ“ Gallery + +### 🎯 PURPOSE +The `gallery` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the gallery logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + gallery[πŸ“ gallery] + gallery --> application[πŸš€ application] + gallery --> domain[πŸ›οΈ domain] + gallery --> infrastructure[πŸ—οΈ infrastructure] + gallery --> presentation[🎨 presentation] + gallery --> gallery_module_ts(gallery.module.ts) + gallery --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.module.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.module.ts`. | @nestjs/common, @nestjs/mongoose | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate gallery into your refined workflows: +import { /* exported members */ } from '@path/to/gallery'; +``` diff --git a/backend/src/modules/gallery/application/README.md b/backend/src/modules/gallery/application/README.md new file mode 100644 index 00000000..1116cd6a --- /dev/null +++ b/backend/src/modules/gallery/application/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) / [application](/backend/src/modules/gallery/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> gallery_service_ts(gallery.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.service.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/gallery/domain/README.md b/backend/src/modules/gallery/domain/README.md new file mode 100644 index 00000000..2075e630 --- /dev/null +++ b/backend/src/modules/gallery/domain/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) / [domain](/backend/src/modules/gallery/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> gallery_entity_ts(gallery.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.entity.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/gallery/infrastructure/README.md b/backend/src/modules/gallery/infrastructure/README.md new file mode 100644 index 00000000..5777116d --- /dev/null +++ b/backend/src/modules/gallery/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) / [infrastructure](/backend/src/modules/gallery/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/gallery/infrastructure/repositories/README.md b/backend/src/modules/gallery/infrastructure/repositories/README.md new file mode 100644 index 00000000..fe06a869 --- /dev/null +++ b/backend/src/modules/gallery/infrastructure/repositories/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) / [infrastructure](/backend/src/modules/gallery/infrastructure) / [repositories](/backend/src/modules/gallery/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> gallery_repository_ts(gallery.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.repository.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.repository.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/gallery/infrastructure/schemas/README.md b/backend/src/modules/gallery/infrastructure/schemas/README.md new file mode 100644 index 00000000..4adcdb00 --- /dev/null +++ b/backend/src/modules/gallery/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) / [infrastructure](/backend/src/modules/gallery/infrastructure) / [schemas](/backend/src/modules/gallery/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> gallery_schema_ts(gallery.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.schema.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/gallery/presentation/README.md b/backend/src/modules/gallery/presentation/README.md new file mode 100644 index 00000000..449f1cd2 --- /dev/null +++ b/backend/src/modules/gallery/presentation/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) / [presentation](/backend/src/modules/gallery/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> gallery_controller_ts(gallery.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.controller.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.controller.ts`. | @nestjs/common, @nestjs/platform-express | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/platform-express` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/gallery/presentation/dto/README.md b/backend/src/modules/gallery/presentation/dto/README.md new file mode 100644 index 00000000..0a8aaaba --- /dev/null +++ b/backend/src/modules/gallery/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [gallery](/backend/src/modules/gallery) / [presentation](/backend/src/modules/gallery/presentation) / [dto](/backend/src/modules/gallery/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_gallery_dto_ts(create-gallery.dto.ts) + dto --> update_gallery_dto_ts(update-gallery.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-gallery.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-gallery.dto.ts`. | None | +| `update-gallery.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-gallery.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/inventory/README.md b/backend/src/modules/inventory/README.md new file mode 100644 index 00000000..19468f6b --- /dev/null +++ b/backend/src/modules/inventory/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) + +## 🏷️ πŸ“ Inventory + +### 🎯 PURPOSE +The `inventory` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the inventory logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + inventory[πŸ“ inventory] + inventory --> application[πŸš€ application] + inventory --> domain[πŸ›οΈ domain] + inventory --> infrastructure[πŸ—οΈ infrastructure] + inventory --> presentation[🎨 presentation] + inventory --> index_ts(index.ts) + inventory --> inventory_module_ts(inventory.module.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `inventory.module.ts` | `ts` | Encapsulates premium logic and definitions for `inventory.module.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate inventory into your refined workflows: +import { /* exported members */ } from '@path/to/inventory'; +``` diff --git a/backend/src/modules/inventory/application/README.md b/backend/src/modules/inventory/application/README.md new file mode 100644 index 00000000..ecb982d3 --- /dev/null +++ b/backend/src/modules/inventory/application/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) / [application](/backend/src/modules/inventory/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> inventory_service_ts(inventory.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `inventory.service.ts` | `ts` | Encapsulates premium logic and definitions for `inventory.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/inventory/domain/README.md b/backend/src/modules/inventory/domain/README.md new file mode 100644 index 00000000..38d43075 --- /dev/null +++ b/backend/src/modules/inventory/domain/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) / [domain](/backend/src/modules/inventory/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> inventory_entity_ts(inventory.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `inventory.entity.ts` | `ts` | Encapsulates premium logic and definitions for `inventory.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/inventory/infrastructure/README.md b/backend/src/modules/inventory/infrastructure/README.md new file mode 100644 index 00000000..b1790734 --- /dev/null +++ b/backend/src/modules/inventory/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) / [infrastructure](/backend/src/modules/inventory/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/inventory/infrastructure/repositories/README.md b/backend/src/modules/inventory/infrastructure/repositories/README.md new file mode 100644 index 00000000..a86c4106 --- /dev/null +++ b/backend/src/modules/inventory/infrastructure/repositories/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) / [infrastructure](/backend/src/modules/inventory/infrastructure) / [repositories](/backend/src/modules/inventory/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> inventory_repository_ts(inventory.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `inventory.repository.ts` | `ts` | Encapsulates premium logic and definitions for `inventory.repository.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/inventory/infrastructure/schemas/README.md b/backend/src/modules/inventory/infrastructure/schemas/README.md new file mode 100644 index 00000000..b43d5f82 --- /dev/null +++ b/backend/src/modules/inventory/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) / [infrastructure](/backend/src/modules/inventory/infrastructure) / [schemas](/backend/src/modules/inventory/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> inventory_schema_ts(inventory.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `inventory.schema.ts` | `ts` | Encapsulates premium logic and definitions for `inventory.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/inventory/presentation/README.md b/backend/src/modules/inventory/presentation/README.md new file mode 100644 index 00000000..18ef98fa --- /dev/null +++ b/backend/src/modules/inventory/presentation/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) / [presentation](/backend/src/modules/inventory/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> inventory_controller_ts(inventory.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `inventory.controller.ts` | `ts` | Encapsulates premium logic and definitions for `inventory.controller.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/inventory/presentation/dto/README.md b/backend/src/modules/inventory/presentation/dto/README.md new file mode 100644 index 00000000..aa270d78 --- /dev/null +++ b/backend/src/modules/inventory/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [inventory](/backend/src/modules/inventory) / [presentation](/backend/src/modules/inventory/presentation) / [dto](/backend/src/modules/inventory/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_inventory_dto_ts(create-inventory.dto.ts) + dto --> update_inventory_dto_ts(update-inventory.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-inventory.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-inventory.dto.ts`. | None | +| `update-inventory.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-inventory.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/partnership/README.md b/backend/src/modules/partnership/README.md new file mode 100644 index 00000000..4a0e4b9b --- /dev/null +++ b/backend/src/modules/partnership/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) + +## 🏷️ πŸ“ Partnership + +### 🎯 PURPOSE +The `partnership` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the partnership logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + partnership[πŸ“ partnership] + partnership --> application[πŸš€ application] + partnership --> domain[πŸ›οΈ domain] + partnership --> infrastructure[πŸ—οΈ infrastructure] + partnership --> presentation[🎨 presentation] + partnership --> index_ts(index.ts) + partnership --> partnership_module_ts(partnership.module.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `partnership.module.ts` | `ts` | Encapsulates premium logic and definitions for `partnership.module.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate partnership into your refined workflows: +import { /* exported members */ } from '@path/to/partnership'; +``` diff --git a/backend/src/modules/partnership/application/README.md b/backend/src/modules/partnership/application/README.md new file mode 100644 index 00000000..ea219ee5 --- /dev/null +++ b/backend/src/modules/partnership/application/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) / [application](/backend/src/modules/partnership/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> partnership_service_ts(partnership.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `partnership.service.ts` | `ts` | Encapsulates premium logic and definitions for `partnership.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/partnership/domain/README.md b/backend/src/modules/partnership/domain/README.md new file mode 100644 index 00000000..82540688 --- /dev/null +++ b/backend/src/modules/partnership/domain/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) / [domain](/backend/src/modules/partnership/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> partnership_entity_ts(partnership.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `partnership.entity.ts` | `ts` | Encapsulates premium logic and definitions for `partnership.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/partnership/infrastructure/README.md b/backend/src/modules/partnership/infrastructure/README.md new file mode 100644 index 00000000..7f1605b0 --- /dev/null +++ b/backend/src/modules/partnership/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) / [infrastructure](/backend/src/modules/partnership/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/partnership/infrastructure/repositories/README.md b/backend/src/modules/partnership/infrastructure/repositories/README.md new file mode 100644 index 00000000..2207dc38 --- /dev/null +++ b/backend/src/modules/partnership/infrastructure/repositories/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) / [infrastructure](/backend/src/modules/partnership/infrastructure) / [repositories](/backend/src/modules/partnership/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> partnership_repository_ts(partnership.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `partnership.repository.ts` | `ts` | Encapsulates premium logic and definitions for `partnership.repository.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/partnership/infrastructure/schemas/README.md b/backend/src/modules/partnership/infrastructure/schemas/README.md new file mode 100644 index 00000000..d86fbbd3 --- /dev/null +++ b/backend/src/modules/partnership/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) / [infrastructure](/backend/src/modules/partnership/infrastructure) / [schemas](/backend/src/modules/partnership/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> partnership_schema_ts(partnership.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `partnership.schema.ts` | `ts` | Encapsulates premium logic and definitions for `partnership.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/partnership/presentation/README.md b/backend/src/modules/partnership/presentation/README.md new file mode 100644 index 00000000..aa88c1e3 --- /dev/null +++ b/backend/src/modules/partnership/presentation/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) / [presentation](/backend/src/modules/partnership/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> partnership_controller_ts(partnership.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `partnership.controller.ts` | `ts` | Encapsulates premium logic and definitions for `partnership.controller.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/partnership/presentation/dto/README.md b/backend/src/modules/partnership/presentation/dto/README.md new file mode 100644 index 00000000..6af895c9 --- /dev/null +++ b/backend/src/modules/partnership/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [partnership](/backend/src/modules/partnership) / [presentation](/backend/src/modules/partnership/presentation) / [dto](/backend/src/modules/partnership/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_partnership_dto_ts(create-partnership.dto.ts) + dto --> update_partnership_dto_ts(update-partnership.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-partnership.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-partnership.dto.ts`. | None | +| `update-partnership.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-partnership.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/payment/README.md b/backend/src/modules/payment/README.md new file mode 100644 index 00000000..b69164ff --- /dev/null +++ b/backend/src/modules/payment/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [payment](/backend/src/modules/payment) + +## 🏷️ πŸ“ Payment + +### 🎯 PURPOSE +The `payment` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the payment logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + payment[πŸ“ payment] + payment --> strategies[πŸ“ strategies] + payment --> index_ts(index.ts) + payment --> payment_controller_ts(payment.controller.ts) + payment --> payment_module_ts(payment.module.ts) + payment --> payment_service_ts(payment.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `payment.controller.ts` | `ts` | Encapsulates premium logic and definitions for `payment.controller.ts`. | @nestjs/common | +| `payment.module.ts` | `ts` | Encapsulates premium logic and definitions for `payment.module.ts`. | @nestjs/common | +| `payment.service.ts` | `ts` | Encapsulates premium logic and definitions for `payment.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate payment into your refined workflows: +import { /* exported members */ } from '@path/to/payment'; +``` diff --git a/backend/src/modules/payment/strategies/README.md b/backend/src/modules/payment/strategies/README.md new file mode 100644 index 00000000..ac8801b1 --- /dev/null +++ b/backend/src/modules/payment/strategies/README.md @@ -0,0 +1,32 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [payment](/backend/src/modules/payment) / [strategies](/backend/src/modules/payment/strategies) + +## 🏷️ πŸ“ Strategies + +### 🎯 PURPOSE +The `strategies` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the strategies logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + strategies[πŸ“ strategies] + strategies --> alif_pay_strategy_ts(alif-pay.strategy.ts) + strategies --> mock_card_strategy_ts(mock-card.strategy.ts) + strategies --> payment_strategy_ts(payment.strategy.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `alif-pay.strategy.ts` | `ts` | Encapsulates premium logic and definitions for `alif-pay.strategy.ts`. | @nestjs/common | +| `mock-card.strategy.ts` | `ts` | Encapsulates premium logic and definitions for `mock-card.strategy.ts`. | @nestjs/common | +| `payment.strategy.ts` | `ts` | Encapsulates premium logic and definitions for `payment.strategy.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate strategies into your refined workflows: +import { /* exported members */ } from '@path/to/strategies'; +``` diff --git a/backend/src/modules/treatments/README.md b/backend/src/modules/treatments/README.md new file mode 100644 index 00000000..36cc3029 --- /dev/null +++ b/backend/src/modules/treatments/README.md @@ -0,0 +1,39 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) + +## 🏷️ πŸ“ Treatments + +### 🎯 PURPOSE +The `treatments` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the treatments logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + treatments[πŸ“ treatments] + treatments --> application[πŸš€ application] + treatments --> domain[πŸ›οΈ domain] + treatments --> infrastructure[πŸ—οΈ infrastructure] + treatments --> presentation[🎨 presentation] + treatments --> index_ts(index.ts) + treatments --> treatments_module_ts(treatments.module.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `treatments.module.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.module.ts`. | @nestjs/common, @modules/treatments/infrastructure/schemas/treatments.schema, @modules/treatments/infrastructure/repositories/treatments.repository, @modules/treatments/presentation/treatments.controller, @modules/treatments/application/treatments.service, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@modules/treatments/application/treatments.service` +- `@modules/treatments/infrastructure/repositories/treatments.repository` +- `@modules/treatments/infrastructure/schemas/treatments.schema` +- `@modules/treatments/presentation/treatments.controller` +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate treatments into your refined workflows: +import { /* exported members */ } from '@path/to/treatments'; +``` diff --git a/backend/src/modules/treatments/application/README.md b/backend/src/modules/treatments/application/README.md new file mode 100644 index 00000000..ae142251 --- /dev/null +++ b/backend/src/modules/treatments/application/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) / [application](/backend/src/modules/treatments/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> treatments_service_ts(treatments.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments.service.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.service.ts`. | @nestjs/common, @common/utils | + + +### πŸ”— DEPENDENCIES +- `@common/utils` +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/treatments/domain/README.md b/backend/src/modules/treatments/domain/README.md new file mode 100644 index 00000000..e6b02a49 --- /dev/null +++ b/backend/src/modules/treatments/domain/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) / [domain](/backend/src/modules/treatments/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> treatments_entity_ts(treatments.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments.entity.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/treatments/infrastructure/README.md b/backend/src/modules/treatments/infrastructure/README.md new file mode 100644 index 00000000..af7eaf3d --- /dev/null +++ b/backend/src/modules/treatments/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) / [infrastructure](/backend/src/modules/treatments/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/treatments/infrastructure/repositories/README.md b/backend/src/modules/treatments/infrastructure/repositories/README.md new file mode 100644 index 00000000..72189bf3 --- /dev/null +++ b/backend/src/modules/treatments/infrastructure/repositories/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) / [infrastructure](/backend/src/modules/treatments/infrastructure) / [repositories](/backend/src/modules/treatments/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> treatments_repository_ts(treatments.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments.repository.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.repository.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/treatments/infrastructure/schemas/README.md b/backend/src/modules/treatments/infrastructure/schemas/README.md new file mode 100644 index 00000000..97d01fd3 --- /dev/null +++ b/backend/src/modules/treatments/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) / [infrastructure](/backend/src/modules/treatments/infrastructure) / [schemas](/backend/src/modules/treatments/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> treatments_schema_ts(treatments.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments.schema.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/treatments/presentation/README.md b/backend/src/modules/treatments/presentation/README.md new file mode 100644 index 00000000..29062241 --- /dev/null +++ b/backend/src/modules/treatments/presentation/README.md @@ -0,0 +1,31 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) / [presentation](/backend/src/modules/treatments/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> treatments_controller_ts(treatments.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments.controller.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.controller.ts`. | @nestjs/common, @modules/treatments, @nestjs/platform-express | + + +### πŸ”— DEPENDENCIES +- `@modules/treatments` +- `@nestjs/common` +- `@nestjs/platform-express` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/treatments/presentation/dto/README.md b/backend/src/modules/treatments/presentation/dto/README.md new file mode 100644 index 00000000..b9c7b6fc --- /dev/null +++ b/backend/src/modules/treatments/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [treatments](/backend/src/modules/treatments) / [presentation](/backend/src/modules/treatments/presentation) / [dto](/backend/src/modules/treatments/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_treatments_dto_ts(create-treatments.dto.ts) + dto --> update_treatments_dto_ts(update-treatments.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-treatments.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-treatments.dto.ts`. | None | +| `update-treatments.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-treatments.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/user/README.md b/backend/src/modules/user/README.md new file mode 100644 index 00000000..b14d555c --- /dev/null +++ b/backend/src/modules/user/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) + +## 🏷️ πŸ“ User + +### 🎯 PURPOSE +The `user` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the user logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + user[πŸ“ user] + user --> application[πŸš€ application] + user --> domain[πŸ›οΈ domain] + user --> infrastructure[πŸ—οΈ infrastructure] + user --> presentation[🎨 presentation] + user --> index_ts(index.ts) + user --> user_module_ts(user.module.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `user.module.ts` | `ts` | Encapsulates premium logic and definitions for `user.module.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate user into your refined workflows: +import { /* exported members */ } from '@path/to/user'; +``` diff --git a/backend/src/modules/user/application/README.md b/backend/src/modules/user/application/README.md new file mode 100644 index 00000000..85edfa1c --- /dev/null +++ b/backend/src/modules/user/application/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) / [application](/backend/src/modules/user/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> user_service_ts(user.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `user.service.ts` | `ts` | Encapsulates premium logic and definitions for `user.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/user/domain/README.md b/backend/src/modules/user/domain/README.md new file mode 100644 index 00000000..34ce5063 --- /dev/null +++ b/backend/src/modules/user/domain/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) / [domain](/backend/src/modules/user/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> user_entity_ts(user.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `user.entity.ts` | `ts` | Encapsulates premium logic and definitions for `user.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/user/infrastructure/README.md b/backend/src/modules/user/infrastructure/README.md new file mode 100644 index 00000000..9ad99ec4 --- /dev/null +++ b/backend/src/modules/user/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) / [infrastructure](/backend/src/modules/user/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/user/infrastructure/repositories/README.md b/backend/src/modules/user/infrastructure/repositories/README.md new file mode 100644 index 00000000..30664ed6 --- /dev/null +++ b/backend/src/modules/user/infrastructure/repositories/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) / [infrastructure](/backend/src/modules/user/infrastructure) / [repositories](/backend/src/modules/user/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> user_repository_ts(user.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `user.repository.ts` | `ts` | Encapsulates premium logic and definitions for `user.repository.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/user/infrastructure/schemas/README.md b/backend/src/modules/user/infrastructure/schemas/README.md new file mode 100644 index 00000000..dad89ef3 --- /dev/null +++ b/backend/src/modules/user/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) / [infrastructure](/backend/src/modules/user/infrastructure) / [schemas](/backend/src/modules/user/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> user_schema_ts(user.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `user.schema.ts` | `ts` | Encapsulates premium logic and definitions for `user.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/user/presentation/README.md b/backend/src/modules/user/presentation/README.md new file mode 100644 index 00000000..44654f35 --- /dev/null +++ b/backend/src/modules/user/presentation/README.md @@ -0,0 +1,32 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) / [presentation](/backend/src/modules/user/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> user_controller_ts(user.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `user.controller.ts` | `ts` | Encapsulates premium logic and definitions for `user.controller.ts`. | @common/interfaces/authenticated-request.interface, @modules/user, @nestjs/common, @nestjs/platform-express | + + +### πŸ”— DEPENDENCIES +- `@common/interfaces/authenticated-request.interface` +- `@modules/user` +- `@nestjs/common` +- `@nestjs/platform-express` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/user/presentation/dto/README.md b/backend/src/modules/user/presentation/dto/README.md new file mode 100644 index 00000000..a2088360 --- /dev/null +++ b/backend/src/modules/user/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [user](/backend/src/modules/user) / [presentation](/backend/src/modules/user/presentation) / [dto](/backend/src/modules/user/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_user_dto_ts(create-user.dto.ts) + dto --> update_user_dto_ts(update-user.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-user.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-user.dto.ts`. | None | +| `update-user.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-user.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/src/modules/veil/README.md b/backend/src/modules/veil/README.md new file mode 100644 index 00000000..99ee0c01 --- /dev/null +++ b/backend/src/modules/veil/README.md @@ -0,0 +1,35 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) + +## 🏷️ πŸ“ Veil + +### 🎯 PURPOSE +The `veil` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veil logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veil[πŸ“ veil] + veil --> application[πŸš€ application] + veil --> domain[πŸ›οΈ domain] + veil --> infrastructure[πŸ—οΈ infrastructure] + veil --> presentation[🎨 presentation] + veil --> index_ts(index.ts) + veil --> veil_module_ts(veil.module.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `veil.module.ts` | `ts` | Encapsulates premium logic and definitions for `veil.module.ts`. | @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veil into your refined workflows: +import { /* exported members */ } from '@path/to/veil'; +``` diff --git a/backend/src/modules/veil/application/README.md b/backend/src/modules/veil/application/README.md new file mode 100644 index 00000000..2fb34f3e --- /dev/null +++ b/backend/src/modules/veil/application/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) / [application](/backend/src/modules/veil/application) + +## 🏷️ πŸš€ Application + +### 🎯 PURPOSE +The `application` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the application logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + application[πŸš€ application] + application --> veil_service_ts(veil.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil.service.ts` | `ts` | Encapsulates premium logic and definitions for `veil.service.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate application into your refined workflows: +import { /* exported members */ } from '@path/to/application'; +``` diff --git a/backend/src/modules/veil/domain/README.md b/backend/src/modules/veil/domain/README.md new file mode 100644 index 00000000..598b78b7 --- /dev/null +++ b/backend/src/modules/veil/domain/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) / [domain](/backend/src/modules/veil/domain) + +## 🏷️ πŸ›οΈ Domain + +### 🎯 PURPOSE +The `domain` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the domain logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + domain[πŸ›οΈ domain] + domain --> veil_entity_ts(veil.entity.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil.entity.ts` | `ts` | Encapsulates premium logic and definitions for `veil.entity.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate domain into your refined workflows: +import { /* exported members */ } from '@path/to/domain'; +``` diff --git a/backend/src/modules/veil/infrastructure/README.md b/backend/src/modules/veil/infrastructure/README.md new file mode 100644 index 00000000..9825ce0a --- /dev/null +++ b/backend/src/modules/veil/infrastructure/README.md @@ -0,0 +1,29 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) / [infrastructure](/backend/src/modules/veil/infrastructure) + +## 🏷️ πŸ—οΈ Infrastructure + +### 🎯 PURPOSE +The `infrastructure` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the infrastructure logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + infrastructure[πŸ—οΈ infrastructure] + infrastructure --> repositories[πŸ—„οΈ repositories] + infrastructure --> schemas[πŸ“‘ schemas] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate infrastructure into your refined workflows: +import { /* exported members */ } from '@path/to/infrastructure'; +``` diff --git a/backend/src/modules/veil/infrastructure/repositories/README.md b/backend/src/modules/veil/infrastructure/repositories/README.md new file mode 100644 index 00000000..6ab9327c --- /dev/null +++ b/backend/src/modules/veil/infrastructure/repositories/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) / [infrastructure](/backend/src/modules/veil/infrastructure) / [repositories](/backend/src/modules/veil/infrastructure/repositories) + +## 🏷️ πŸ—„οΈ Repositories + +### 🎯 PURPOSE +The `repositories` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the repositories logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + repositories[πŸ—„οΈ repositories] + repositories --> veil_repository_ts(veil.repository.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil.repository.ts` | `ts` | Encapsulates premium logic and definitions for `veil.repository.ts`. | @common/utils/file-system, @nestjs/common, @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@common/utils/file-system` +- `@nestjs/common` +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate repositories into your refined workflows: +import { /* exported members */ } from '@path/to/repositories'; +``` diff --git a/backend/src/modules/veil/infrastructure/schemas/README.md b/backend/src/modules/veil/infrastructure/schemas/README.md new file mode 100644 index 00000000..4bb9185e --- /dev/null +++ b/backend/src/modules/veil/infrastructure/schemas/README.md @@ -0,0 +1,28 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) / [infrastructure](/backend/src/modules/veil/infrastructure) / [schemas](/backend/src/modules/veil/infrastructure/schemas) + +## 🏷️ πŸ“‘ Schemas + +### 🎯 PURPOSE +The `schemas` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the schemas logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + schemas[πŸ“‘ schemas] + schemas --> veil_schema_ts(veil.schema.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil.schema.ts` | `ts` | Encapsulates premium logic and definitions for `veil.schema.ts`. | @nestjs/mongoose | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mongoose` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate schemas into your refined workflows: +import { /* exported members */ } from '@path/to/schemas'; +``` diff --git a/backend/src/modules/veil/presentation/README.md b/backend/src/modules/veil/presentation/README.md new file mode 100644 index 00000000..4a11d79a --- /dev/null +++ b/backend/src/modules/veil/presentation/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) / [presentation](/backend/src/modules/veil/presentation) + +## 🏷️ 🎨 Presentation + +### 🎯 PURPOSE +The `presentation` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the presentation logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + presentation[🎨 presentation] + presentation --> dto[πŸ“¨ dto] + presentation --> veil_controller_ts(veil.controller.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil.controller.ts` | `ts` | Encapsulates premium logic and definitions for `veil.controller.ts`. | @nestjs/common, @nestjs/platform-express | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/platform-express` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate presentation into your refined workflows: +import { /* exported members */ } from '@path/to/presentation'; +``` diff --git a/backend/src/modules/veil/presentation/dto/README.md b/backend/src/modules/veil/presentation/dto/README.md new file mode 100644 index 00000000..6d24af80 --- /dev/null +++ b/backend/src/modules/veil/presentation/dto/README.md @@ -0,0 +1,30 @@ +# [backend](/backend) / [src](/backend/src) / [modules](/backend/src/modules) / [veil](/backend/src/modules/veil) / [presentation](/backend/src/modules/veil/presentation) / [dto](/backend/src/modules/veil/presentation/dto) + +## 🏷️ πŸ“¨ Dto + +### 🎯 PURPOSE +The `dto` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dto logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dto[πŸ“¨ dto] + dto --> create_veil_dto_ts(create-veil.dto.ts) + dto --> update_veil_dto_ts(update-veil.dto.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `create-veil.dto.ts` | `ts` | Encapsulates premium logic and definitions for `create-veil.dto.ts`. | None | +| `update-veil.dto.ts` | `ts` | Encapsulates premium logic and definitions for `update-veil.dto.ts`. | @nestjs/mapped-types | + + +### πŸ”— DEPENDENCIES +- `@nestjs/mapped-types` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dto into your refined workflows: +import { /* exported members */ } from '@path/to/dto'; +``` diff --git a/backend/test/README.md b/backend/test/README.md new file mode 100644 index 00000000..eaf193fa --- /dev/null +++ b/backend/test/README.md @@ -0,0 +1,31 @@ +# [backend](/backend) / [test](/backend/test) + +## 🏷️ πŸ“ Test + +### 🎯 PURPOSE +The `test` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the test logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + test[πŸ“ test] + test --> app_e2e_spec_ts(app.e2e-spec.ts) + test --> jest_e2e_json(jest-e2e.json) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `app.e2e-spec.ts` | `ts` | Encapsulates premium logic and definitions for `app.e2e-spec.ts`. | @nestjs/testing, @nestjs/common | +| `jest-e2e.json` | `json` | Configuration and foundational asset. | None | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` +- `@nestjs/testing` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate test into your refined workflows: +import { /* exported members */ } from '@path/to/test'; +``` diff --git a/frontend/README.md b/frontend/README.md index 836db5fd..17f90763 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,20 +1,42 @@ -
-GHBanner -
+# [frontend](/frontend) -# Run and deploy your AI Studio app +## 🏷️ πŸ“ Frontend -This contains everything you need to run your app locally. +### 🎯 PURPOSE +The `frontend` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the frontend logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. -View your app in AI Studio: https://ai.studio/apps/drive/1kmc9jHeqaKUBxlnUPMx3MZ54urT7DvlR +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + frontend[πŸ“ frontend] + frontend --> public[πŸ“ public] + frontend --> src[πŸ“ src] + frontend --> angular_json(angular.json) + frontend --> index_html(index.html) + frontend --> index_tsx(index.tsx) + frontend --> metadata_json(metadata.json) + frontend --> package_lock_json(package-lock.json) + frontend --> package_json(package.json) + frontend --> tsconfig_json(tsconfig.json) +``` -## Run Locally +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `angular.json` | `json` | Configuration and foundational asset. | None | +| `index.html` | `html` | Encapsulates premium logic and definitions for `index.html`. | None | +| `index.tsx` | `tsx` | Configuration and foundational asset. | None | +| `metadata.json` | `json` | Configuration and foundational asset. | None | +| `package-lock.json` | `json` | Configuration and foundational asset. | None | +| `package.json` | `json` | Configuration and foundational asset. | None | +| `tsconfig.json` | `json` | Configuration and foundational asset. | None | -**Prerequisites:** Node.js +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* -1. Install dependencies: - `npm install` -2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key -3. Run the app: - `npm run dev` +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate frontend into your refined workflows: +import { /* exported members */ } from '@path/to/frontend'; +``` diff --git a/frontend/public/README.md b/frontend/public/README.md new file mode 100644 index 00000000..bdbc1fa2 --- /dev/null +++ b/frontend/public/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [public](/frontend/public) + +## 🏷️ πŸ“ Public + +### 🎯 PURPOSE +The `public` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the public logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + public[πŸ“ public] + public --> images[πŸ“ images] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate public into your refined workflows: +import { /* exported members */ } from '@path/to/public'; +``` diff --git a/frontend/public/images/README.md b/frontend/public/images/README.md new file mode 100644 index 00000000..266fb2d6 --- /dev/null +++ b/frontend/public/images/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [public](/frontend/public) / [images](/frontend/public/images) + +## 🏷️ πŸ“ Images + +### 🎯 PURPOSE +The `images` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the images logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + images[πŸ“ images] + images --> treatments_add_img_png(treatments-add-img.png) + images --> treatments_no_img_png(treatments-no-img.png) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments-add-img.png` | `png` | Configuration and foundational asset. | None | +| `treatments-no-img.png` | `png` | Configuration and foundational asset. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate images into your refined workflows: +import { /* exported members */ } from '@path/to/images'; +``` diff --git a/frontend/src/README.md b/frontend/src/README.md new file mode 100644 index 00000000..80bc30fe --- /dev/null +++ b/frontend/src/README.md @@ -0,0 +1,51 @@ +# [frontend](/frontend) / [src](/frontend/src) + +## 🏷️ πŸ“ Src + +### 🎯 PURPOSE +The `src` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the src logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + src[πŸ“ src] + src --> app[πŸ“ app] + src --> backend[πŸ“ backend] + src --> core[🧠 core] + src --> entities[πŸ—ƒοΈ entities] + src --> environments[πŸ“ environments] + src --> features[🌟 features] + src --> locale[πŸ“ locale] + src --> pages[πŸ“„ pages] + src --> shared[🀝 shared] + src --> types[πŸ“ types] + src --> widgets[πŸͺŸ widgets] + src --> app_component_html(app.component.html) + src --> app_component_scss(app.component.scss) + src --> app_component_ts(app.component.ts) + src --> app_routes_ts(app.routes.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `app.component.html` | `html` | Encapsulates premium logic and definitions for `app.component.html`. | None | +| `app.component.scss` | `scss` | Encapsulates premium logic and definitions for `app.component.scss`. | None | +| `app.component.ts` | `ts` | Encapsulates premium logic and definitions for `app.component.ts`. | @shared/ui, @angular/common, @angular/core, @angular/router, @shared/services | +| `app.routes.ts` | `ts` | Encapsulates premium logic and definitions for `app.routes.ts`. | @angular/router, @widgets/layouts, @pages/auth | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/router` +- `@pages/auth` +- `@shared/services` +- `@shared/ui` +- `@widgets/layouts` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate src into your refined workflows: +import { /* exported members */ } from '@path/to/src'; +``` diff --git a/frontend/src/app/README.md b/frontend/src/app/README.md new file mode 100644 index 00000000..596e0557 --- /dev/null +++ b/frontend/src/app/README.md @@ -0,0 +1,33 @@ +# [frontend](/frontend) / [src](/frontend/src) / [app](/frontend/src/app) + +## 🏷️ πŸ“ App + +### 🎯 PURPOSE +The `app` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the app logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **App** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + app[πŸ“ app] + app --> app_config_ts(app.config.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `app.config.ts` | `ts` | Encapsulates premium logic and definitions for `app.config.ts`. | @angular/core, @angular/common/http, @angular/router, @angular/platform-browser/animations, @core/interceptors, @src/app.routes | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@angular/platform-browser/animations` +- `@angular/router` +- `@core/interceptors` +- `@src/app.routes` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate app into your refined workflows: +import { /* exported members */ } from '@path/to/app'; +``` diff --git a/frontend/src/backend/README.md b/frontend/src/backend/README.md new file mode 100644 index 00000000..80049ff3 --- /dev/null +++ b/frontend/src/backend/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [src](/frontend/src) / [backend](/frontend/src/backend) + +## 🏷️ πŸ“ Backend + +### 🎯 PURPOSE +The `backend` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the backend logic to ensure a seamless and premium experience. Rooted in the NestJS backend architecture, it delivers robust, high-performance operations tailored for high-end beauty and wedding services. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + backend[πŸ“ backend] + backend --> index_ts(index.ts) + backend --> telegram_auth_guard_ts(telegram-auth.guard.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `telegram-auth.guard.ts` | `ts` | Encapsulates premium logic and definitions for `telegram-auth.guard.ts`. | @nestjs/common | + + +### πŸ”— DEPENDENCIES +- `@nestjs/common` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate backend into your refined workflows: +import { /* exported members */ } from '@path/to/backend'; +``` diff --git a/frontend/src/core/README.md b/frontend/src/core/README.md new file mode 100644 index 00000000..a36653de --- /dev/null +++ b/frontend/src/core/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [src](/frontend/src) / [core](/frontend/src/core) + +## 🏷️ 🧠 Core + +### 🎯 PURPOSE +The `core` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the core logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + core[🧠 core] + core --> constants[πŸ“Œ constants] + core --> guards[πŸ›‘οΈ guards] + core --> interceptors[πŸ“ interceptors] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate core into your refined workflows: +import { /* exported members */ } from '@path/to/core'; +``` diff --git a/frontend/src/core/constants/README.md b/frontend/src/core/constants/README.md new file mode 100644 index 00000000..56394648 --- /dev/null +++ b/frontend/src/core/constants/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [src](/frontend/src) / [core](/frontend/src/core) / [constants](/frontend/src/core/constants) + +## 🏷️ πŸ“Œ Constants + +### 🎯 PURPOSE +The `constants` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the constants logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + constants[πŸ“Œ constants] + constants --> api_endpoints_ts(api-endpoints.ts) + constants --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `api-endpoints.ts` | `ts` | Encapsulates premium logic and definitions for `api-endpoints.ts`. | @shared/lib | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate constants into your refined workflows: +import { /* exported members */ } from '@path/to/constants'; +``` diff --git a/frontend/src/core/guards/README.md b/frontend/src/core/guards/README.md new file mode 100644 index 00000000..940c14ee --- /dev/null +++ b/frontend/src/core/guards/README.md @@ -0,0 +1,34 @@ +# [frontend](/frontend) / [src](/frontend/src) / [core](/frontend/src/core) / [guards](/frontend/src/core/guards) + +## 🏷️ πŸ›‘οΈ Guards + +### 🎯 PURPOSE +The `guards` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the guards logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + guards[πŸ›‘οΈ guards] + guards --> admin_guard_ts(admin.guard.ts) + guards --> auth_guard_ts(auth.guard.ts) + guards --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin.guard.ts` | `ts` | Encapsulates premium logic and definitions for `admin.guard.ts`. | @entities/user, @angular/core, @angular/router | +| `auth.guard.ts` | `ts` | Encapsulates premium logic and definitions for `auth.guard.ts`. | @entities/user, @angular/core, @angular/router | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/core` +- `@angular/router` +- `@entities/user` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate guards into your refined workflows: +import { /* exported members */ } from '@path/to/guards'; +``` diff --git a/frontend/src/core/interceptors/README.md b/frontend/src/core/interceptors/README.md new file mode 100644 index 00000000..5efb416b --- /dev/null +++ b/frontend/src/core/interceptors/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [core](/frontend/src/core) / [interceptors](/frontend/src/core/interceptors) + +## 🏷️ πŸ“ Interceptors + +### 🎯 PURPOSE +The `interceptors` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the interceptors logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + interceptors[πŸ“ interceptors] + interceptors --> api_interceptor_ts(api.interceptor.ts) + interceptors --> error_interceptor_ts(error.interceptor.ts) + interceptors --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `api.interceptor.ts` | `ts` | Encapsulates premium logic and definitions for `api.interceptor.ts`. | @shared/lib, @angular/common/http | +| `error.interceptor.ts` | `ts` | Encapsulates premium logic and definitions for `error.interceptor.ts`. | @angular/core, @shared/services, @angular/common/http | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@shared/lib` +- `@shared/services` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate interceptors into your refined workflows: +import { /* exported members */ } from '@path/to/interceptors'; +``` diff --git a/frontend/src/entities/README.md b/frontend/src/entities/README.md index 00c08c6a..3f0d3688 100644 --- a/frontend/src/entities/README.md +++ b/frontend/src/entities/README.md @@ -1,8 +1,32 @@ -# Entities Layer +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) -This layer contains business entities (e.g., User, Product, Order). -Each slice should contain: +## 🏷️ πŸ—ƒοΈ Entities -- `model`: Interfaces/Types (re-exported from shared/models or specific to ui) -- `ui`: Components -- `api`: Services +### 🎯 PURPOSE +The `entities` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the entities logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + entities[πŸ—ƒοΈ entities] + entities --> admin-settings[πŸ“ admin-settings] + entities --> gallery[πŸ“ gallery] + entities --> treatments[πŸ“ treatments] + entities --> user[πŸ“ user] + entities --> veil[πŸ“ veil] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate entities into your refined workflows: +import { /* exported members */ } from '@path/to/entities'; +``` diff --git a/frontend/src/entities/admin-settings/README.md b/frontend/src/entities/admin-settings/README.md new file mode 100644 index 00000000..53dc3f1e --- /dev/null +++ b/frontend/src/entities/admin-settings/README.md @@ -0,0 +1,33 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [admin-settings](/frontend/src/entities/admin-settings) + +## 🏷️ πŸ“ Admin-settings + +### 🎯 PURPOSE +The `admin-settings` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the admin-settings logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + admin-settings[πŸ“ admin-settings] + admin-settings --> admin_settings_service_ts(admin-settings.service.ts) + admin-settings --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.service.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.service.ts`. | @shared/models/admin-settings.model, @core/constants/api-endpoints, @angular/core, @angular/common/http | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@core/constants/api-endpoints` +- `@shared/models/admin-settings.model` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate admin-settings into your refined workflows: +import { /* exported members */ } from '@path/to/admin-settings'; +``` diff --git a/frontend/src/entities/gallery/README.md b/frontend/src/entities/gallery/README.md new file mode 100644 index 00000000..5c8d0afc --- /dev/null +++ b/frontend/src/entities/gallery/README.md @@ -0,0 +1,33 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [gallery](/frontend/src/entities/gallery) + +## 🏷️ πŸ“ Gallery + +### 🎯 PURPOSE +The `gallery` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the gallery logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + gallery[πŸ“ gallery] + gallery --> constants[πŸ“Œ constants] + gallery --> gallery_service_ts(gallery.service.ts) + gallery --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.service.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.service.ts`. | @shared/models, @angular/core, @angular/common/http | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@shared/models` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate gallery into your refined workflows: +import { /* exported members */ } from '@path/to/gallery'; +``` diff --git a/frontend/src/entities/gallery/constants/README.md b/frontend/src/entities/gallery/constants/README.md new file mode 100644 index 00000000..dd3430cb --- /dev/null +++ b/frontend/src/entities/gallery/constants/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [gallery](/frontend/src/entities/gallery) / [constants](/frontend/src/entities/gallery/constants) + +## 🏷️ πŸ“Œ Constants + +### 🎯 PURPOSE +The `constants` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the constants logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + constants[πŸ“Œ constants] + constants --> gallery_constants_ts(gallery.constants.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.constants.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.constants.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate constants into your refined workflows: +import { /* exported members */ } from '@path/to/constants'; +``` diff --git a/frontend/src/entities/treatments/README.md b/frontend/src/entities/treatments/README.md new file mode 100644 index 00000000..6e497975 --- /dev/null +++ b/frontend/src/entities/treatments/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [treatments](/frontend/src/entities/treatments) + +## 🏷️ πŸ“ Treatments + +### 🎯 PURPOSE +The `treatments` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the treatments logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + treatments[πŸ“ treatments] + treatments --> constants[πŸ“Œ constants] + treatments --> index_ts(index.ts) + treatments --> treatments_service_ts(treatments.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `treatments.service.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.service.ts`. | @angular/core, @shared/lib, @core/constants, @angular/common/http, @features/treatments | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@core/constants` +- `@features/treatments` +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate treatments into your refined workflows: +import { /* exported members */ } from '@path/to/treatments'; +``` diff --git a/frontend/src/entities/treatments/constants/README.md b/frontend/src/entities/treatments/constants/README.md new file mode 100644 index 00000000..d99b4bfa --- /dev/null +++ b/frontend/src/entities/treatments/constants/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [treatments](/frontend/src/entities/treatments) / [constants](/frontend/src/entities/treatments/constants) + +## 🏷️ πŸ“Œ Constants + +### 🎯 PURPOSE +The `constants` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the constants logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + constants[πŸ“Œ constants] + constants --> treatments_constants_ts(treatments.constants.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments.constants.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.constants.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate constants into your refined workflows: +import { /* exported members */ } from '@path/to/constants'; +``` diff --git a/frontend/src/entities/user/README.md b/frontend/src/entities/user/README.md new file mode 100644 index 00000000..34e5706c --- /dev/null +++ b/frontend/src/entities/user/README.md @@ -0,0 +1,36 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [user](/frontend/src/entities/user) + +## 🏷️ πŸ“ User + +### 🎯 PURPOSE +The `user` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the user logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + user[πŸ“ user] + user --> constants[πŸ“Œ constants] + user --> model[πŸ“ model] + user --> auth_service_ts(auth.service.ts) + user --> index_ts(index.ts) + user --> user_service_ts(user.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `auth.service.ts` | `ts` | Encapsulates premium logic and definitions for `auth.service.ts`. | @angular/core, @angular/router, @angular/common/http | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `user.service.ts` | `ts` | Encapsulates premium logic and definitions for `user.service.ts`. | @angular/core, @angular/common/http | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@angular/router` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate user into your refined workflows: +import { /* exported members */ } from '@path/to/user'; +``` diff --git a/frontend/src/entities/user/constants/README.md b/frontend/src/entities/user/constants/README.md new file mode 100644 index 00000000..c3af725d --- /dev/null +++ b/frontend/src/entities/user/constants/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [user](/frontend/src/entities/user) / [constants](/frontend/src/entities/user/constants) + +## 🏷️ πŸ“Œ Constants + +### 🎯 PURPOSE +The `constants` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the constants logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + constants[πŸ“Œ constants] + constants --> user_constants_ts(user.constants.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `user.constants.ts` | `ts` | Encapsulates premium logic and definitions for `user.constants.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate constants into your refined workflows: +import { /* exported members */ } from '@path/to/constants'; +``` diff --git a/frontend/src/entities/user/model/README.md b/frontend/src/entities/user/model/README.md new file mode 100644 index 00000000..6a47d912 --- /dev/null +++ b/frontend/src/entities/user/model/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [user](/frontend/src/entities/user) / [model](/frontend/src/entities/user/model) + +## 🏷️ πŸ“ Model + +### 🎯 PURPOSE +The `model` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the model logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + model[πŸ“ model] + model --> user_model_ts(user.model.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `user.model.ts` | `ts` | Encapsulates premium logic and definitions for `user.model.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate model into your refined workflows: +import { /* exported members */ } from '@path/to/model'; +``` diff --git a/frontend/src/entities/veil/README.md b/frontend/src/entities/veil/README.md new file mode 100644 index 00000000..49f3b6b1 --- /dev/null +++ b/frontend/src/entities/veil/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [veil](/frontend/src/entities/veil) + +## 🏷️ πŸ“ Veil + +### 🎯 PURPOSE +The `veil` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veil logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veil[πŸ“ veil] + veil --> constants[πŸ“Œ constants] + veil --> index_ts(index.ts) + veil --> veil_service_ts(veil.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `veil.service.ts` | `ts` | Encapsulates premium logic and definitions for `veil.service.ts`. | @angular/core, @shared/lib, @core/constants, @features/veil, @angular/common/http | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@core/constants` +- `@features/veil` +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veil into your refined workflows: +import { /* exported members */ } from '@path/to/veil'; +``` diff --git a/frontend/src/entities/veil/constants/README.md b/frontend/src/entities/veil/constants/README.md new file mode 100644 index 00000000..9cce0a8b --- /dev/null +++ b/frontend/src/entities/veil/constants/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [entities](/frontend/src/entities) / [veil](/frontend/src/entities/veil) / [constants](/frontend/src/entities/veil/constants) + +## 🏷️ πŸ“Œ Constants + +### 🎯 PURPOSE +The `constants` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the constants logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Entities** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + constants[πŸ“Œ constants] + constants --> veil_constants_ts(veil.constants.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil.constants.ts` | `ts` | Encapsulates premium logic and definitions for `veil.constants.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate constants into your refined workflows: +import { /* exported members */ } from '@path/to/constants'; +``` diff --git a/frontend/src/environments/README.md b/frontend/src/environments/README.md new file mode 100644 index 00000000..5e35312e --- /dev/null +++ b/frontend/src/environments/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [src](/frontend/src) / [environments](/frontend/src/environments) + +## 🏷️ πŸ“ Environments + +### 🎯 PURPOSE +The `environments` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the environments logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + environments[πŸ“ environments] + environments --> environment_prod_ts(environment.prod.ts) + environments --> environment_ts(environment.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `environment.prod.ts` | `ts` | Encapsulates premium logic and definitions for `environment.prod.ts`. | None | +| `environment.ts` | `ts` | Encapsulates premium logic and definitions for `environment.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate environments into your refined workflows: +import { /* exported members */ } from '@path/to/environments'; +``` diff --git a/frontend/src/features/README.md b/frontend/src/features/README.md new file mode 100644 index 00000000..1cd8ced0 --- /dev/null +++ b/frontend/src/features/README.md @@ -0,0 +1,32 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) + +## 🏷️ 🌟 Features + +### 🎯 PURPOSE +The `features` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the features logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + features[🌟 features] + features --> client-form[πŸ“ client-form] + features --> gallery[πŸ“ gallery] + features --> language-selection[πŸ“ language-selection] + features --> treatments[πŸ“ treatments] + features --> veil[πŸ“ veil] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate features into your refined workflows: +import { /* exported members */ } from '@path/to/features'; +``` diff --git a/frontend/src/features/client-form/README.md b/frontend/src/features/client-form/README.md new file mode 100644 index 00000000..a52112e8 --- /dev/null +++ b/frontend/src/features/client-form/README.md @@ -0,0 +1,36 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [client-form](/frontend/src/features/client-form) + +## 🏷️ πŸ“ Client-form + +### 🎯 PURPOSE +The `client-form` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the client-form logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + client-form[πŸ“ client-form] + client-form --> client_form_component_html(client-form.component.html) + client-form --> client_form_component_ts(client-form.component.ts) + client-form --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `client-form.component.html` | `html` | Encapsulates premium logic and definitions for `client-form.component.html`. | None | +| `client-form.component.ts` | `ts` | Encapsulates premium logic and definitions for `client-form.component.ts`. | @angular/common, @angular/core, @shared/lib, @angular/forms, @entities/user | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@entities/user` +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate client-form into your refined workflows: +import { /* exported members */ } from '@path/to/client-form'; +``` diff --git a/frontend/src/features/gallery/README.md b/frontend/src/features/gallery/README.md new file mode 100644 index 00000000..0a2b6780 --- /dev/null +++ b/frontend/src/features/gallery/README.md @@ -0,0 +1,29 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [gallery](/frontend/src/features/gallery) + +## 🏷️ πŸ“ Gallery + +### 🎯 PURPOSE +The `gallery` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the gallery logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + gallery[πŸ“ gallery] + gallery --> model[πŸ“ model] + gallery --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate gallery into your refined workflows: +import { /* exported members */ } from '@path/to/gallery'; +``` diff --git a/frontend/src/features/gallery/model/README.md b/frontend/src/features/gallery/model/README.md new file mode 100644 index 00000000..12a32c25 --- /dev/null +++ b/frontend/src/features/gallery/model/README.md @@ -0,0 +1,29 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [gallery](/frontend/src/features/gallery) / [model](/frontend/src/features/gallery/model) + +## 🏷️ πŸ“ Model + +### 🎯 PURPOSE +The `model` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the model logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + model[πŸ“ model] + model --> gallery_data_ts(gallery.data.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.data.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.data.ts`. | @shared/models, @angular/forms/signals | + + +### πŸ”— DEPENDENCIES +- `@angular/forms/signals` +- `@shared/models` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate model into your refined workflows: +import { /* exported members */ } from '@path/to/model'; +``` diff --git a/frontend/src/features/language-selection/README.md b/frontend/src/features/language-selection/README.md new file mode 100644 index 00000000..ed0da7bd --- /dev/null +++ b/frontend/src/features/language-selection/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [language-selection](/frontend/src/features/language-selection) + +## 🏷️ πŸ“ Language-selection + +### 🎯 PURPOSE +The `language-selection` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the language-selection logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + language-selection[πŸ“ language-selection] + language-selection --> index_ts(index.ts) + language-selection --> language_switcher_component_html(language-switcher.component.html) + language-selection --> language_switcher_component_scss(language-switcher.component.scss) + language-selection --> language_switcher_component_ts(language-switcher.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `language-switcher.component.html` | `html` | Encapsulates premium logic and definitions for `language-switcher.component.html`. | None | +| `language-switcher.component.scss` | `scss` | Encapsulates premium logic and definitions for `language-switcher.component.scss`. | None | +| `language-switcher.component.ts` | `ts` | Encapsulates premium logic and definitions for `language-switcher.component.ts`. | @angular/core, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate language-selection into your refined workflows: +import { /* exported members */ } from '@path/to/language-selection'; +``` diff --git a/frontend/src/features/treatments/README.md b/frontend/src/features/treatments/README.md new file mode 100644 index 00000000..d1f91dd4 --- /dev/null +++ b/frontend/src/features/treatments/README.md @@ -0,0 +1,29 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [treatments](/frontend/src/features/treatments) + +## 🏷️ πŸ“ Treatments + +### 🎯 PURPOSE +The `treatments` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the treatments logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + treatments[πŸ“ treatments] + treatments --> model[πŸ“ model] + treatments --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate treatments into your refined workflows: +import { /* exported members */ } from '@path/to/treatments'; +``` diff --git a/frontend/src/features/treatments/model/README.md b/frontend/src/features/treatments/model/README.md new file mode 100644 index 00000000..8e98569f --- /dev/null +++ b/frontend/src/features/treatments/model/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [treatments](/frontend/src/features/treatments) / [model](/frontend/src/features/treatments/model) + +## 🏷️ πŸ“ Model + +### 🎯 PURPOSE +The `model` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the model logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + model[πŸ“ model] + model --> treatments_data_ts(treatments.data.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatments.data.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.data.ts`. | @angular/forms/signals | + + +### πŸ”— DEPENDENCIES +- `@angular/forms/signals` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate model into your refined workflows: +import { /* exported members */ } from '@path/to/model'; +``` diff --git a/frontend/src/features/veil/README.md b/frontend/src/features/veil/README.md new file mode 100644 index 00000000..aa25f789 --- /dev/null +++ b/frontend/src/features/veil/README.md @@ -0,0 +1,29 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [veil](/frontend/src/features/veil) + +## 🏷️ πŸ“ Veil + +### 🎯 PURPOSE +The `veil` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veil logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veil[πŸ“ veil] + veil --> model[πŸ“ model] + veil --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veil into your refined workflows: +import { /* exported members */ } from '@path/to/veil'; +``` diff --git a/frontend/src/features/veil/model/README.md b/frontend/src/features/veil/model/README.md new file mode 100644 index 00000000..fc394806 --- /dev/null +++ b/frontend/src/features/veil/model/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [features](/frontend/src/features) / [veil](/frontend/src/features/veil) / [model](/frontend/src/features/veil/model) + +## 🏷️ πŸ“ Model + +### 🎯 PURPOSE +The `model` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the model logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Features** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + model[πŸ“ model] + model --> veil_data_ts(veil.data.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil.data.ts` | `ts` | Encapsulates premium logic and definitions for `veil.data.ts`. | @angular/forms/signals | + + +### πŸ”— DEPENDENCIES +- `@angular/forms/signals` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate model into your refined workflows: +import { /* exported members */ } from '@path/to/model'; +``` diff --git a/frontend/src/locale/README.md b/frontend/src/locale/README.md new file mode 100644 index 00000000..8ef6fea3 --- /dev/null +++ b/frontend/src/locale/README.md @@ -0,0 +1,32 @@ +# [frontend](/frontend) / [src](/frontend/src) / [locale](/frontend/src/locale) + +## 🏷️ πŸ“ Locale + +### 🎯 PURPOSE +The `locale` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the locale logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + locale[πŸ“ locale] + locale --> messages_ru_xlf(messages.ru.xlf) + locale --> messages_tj_xlf(messages.tj.xlf) + locale --> messages_xlf(messages.xlf) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `messages.ru.xlf` | `xlf` | Configuration and foundational asset. | None | +| `messages.tj.xlf` | `xlf` | Configuration and foundational asset. | None | +| `messages.xlf` | `xlf` | Configuration and foundational asset. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate locale into your refined workflows: +import { /* exported members */ } from '@path/to/locale'; +``` diff --git a/frontend/src/pages/README.md b/frontend/src/pages/README.md new file mode 100644 index 00000000..6ab9f33f --- /dev/null +++ b/frontend/src/pages/README.md @@ -0,0 +1,41 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) + +## 🏷️ πŸ“„ Pages + +### 🎯 PURPOSE +The `pages` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the pages logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + pages[πŸ“„ pages] + pages --> about[πŸ“ about] + pages --> auth[πŸ“ auth] + pages --> clients[πŸ“ clients] + pages --> dashboard[πŸ“ dashboard] + pages --> gallery[πŸ“ gallery] + pages --> inventory[πŸ“ inventory] + pages --> portfolio[πŸ“ portfolio] + pages --> settings[πŸ“ settings] + pages --> treatments[πŸ“ treatments] + pages --> treatments-catalog[πŸ“ treatments-catalog] + pages --> user-home[πŸ“ user-home] + pages --> user-profile[πŸ“ user-profile] + pages --> veil[πŸ“ veil] + pages --> veils-catalog[πŸ“ veils-catalog] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate pages into your refined workflows: +import { /* exported members */ } from '@path/to/pages'; +``` diff --git a/frontend/src/pages/about/README.md b/frontend/src/pages/about/README.md new file mode 100644 index 00000000..601eaa90 --- /dev/null +++ b/frontend/src/pages/about/README.md @@ -0,0 +1,36 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [about](/frontend/src/pages/about) + +## 🏷️ πŸ“ About + +### 🎯 PURPOSE +The `about` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the about logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + about[πŸ“ about] + about --> about_component_html(about.component.html) + about --> about_component_scss(about.component.scss) + about --> about_component_ts(about.component.ts) + about --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `about.component.html` | `html` | Encapsulates premium logic and definitions for `about.component.html`. | None | +| `about.component.scss` | `scss` | Encapsulates premium logic and definitions for `about.component.scss`. | None | +| `about.component.ts` | `ts` | Encapsulates premium logic and definitions for `about.component.ts`. | @angular/core, @angular/forms/signals, @angular/common | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms/signals` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate about into your refined workflows: +import { /* exported members */ } from '@path/to/about'; +``` diff --git a/frontend/src/pages/auth/README.md b/frontend/src/pages/auth/README.md new file mode 100644 index 00000000..fd143010 --- /dev/null +++ b/frontend/src/pages/auth/README.md @@ -0,0 +1,39 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [auth](/frontend/src/pages/auth) + +## 🏷️ πŸ“ Auth + +### 🎯 PURPOSE +The `auth` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the auth logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + auth[πŸ“ auth] + auth --> auth_component_html(auth.component.html) + auth --> auth_component_scss(auth.component.scss) + auth --> auth_component_ts(auth.component.ts) + auth --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `auth.component.html` | `html` | Encapsulates premium logic and definitions for `auth.component.html`. | None | +| `auth.component.scss` | `scss` | Encapsulates premium logic and definitions for `auth.component.scss`. | None | +| `auth.component.ts` | `ts` | Encapsulates premium logic and definitions for `auth.component.ts`. | @angular/common, @angular/core, @features/language-selection, @angular/forms/signals, @angular/router, @entities/user | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms/signals` +- `@angular/router` +- `@entities/user` +- `@features/language-selection` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate auth into your refined workflows: +import { /* exported members */ } from '@path/to/auth'; +``` diff --git a/frontend/src/pages/clients/README.md b/frontend/src/pages/clients/README.md new file mode 100644 index 00000000..57129f5f --- /dev/null +++ b/frontend/src/pages/clients/README.md @@ -0,0 +1,37 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [clients](/frontend/src/pages/clients) + +## 🏷️ πŸ“ Clients + +### 🎯 PURPOSE +The `clients` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the clients logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + clients[πŸ“ clients] + clients --> clients_component_html(clients.component.html) + clients --> clients_component_ts(clients.component.ts) + clients --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `clients.component.html` | `html` | Encapsulates premium logic and definitions for `clients.component.html`. | None | +| `clients.component.ts` | `ts` | Encapsulates premium logic and definitions for `clients.component.ts`. | @shared/ui, @features/client-form, @angular/common, @angular/core, @angular/forms, @entities/user | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@entities/user` +- `@features/client-form` +- `@shared/ui` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate clients into your refined workflows: +import { /* exported members */ } from '@path/to/clients'; +``` diff --git a/frontend/src/pages/dashboard/README.md b/frontend/src/pages/dashboard/README.md new file mode 100644 index 00000000..d60a29f3 --- /dev/null +++ b/frontend/src/pages/dashboard/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [dashboard](/frontend/src/pages/dashboard) + +## 🏷️ πŸ“ Dashboard + +### 🎯 PURPOSE +The `dashboard` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the dashboard logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + dashboard[πŸ“ dashboard] + dashboard --> dashboard_component_html(dashboard.component.html) + dashboard --> dashboard_component_scss(dashboard.component.scss) + dashboard --> dashboard_component_ts(dashboard.component.ts) + dashboard --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `dashboard.component.html` | `html` | Encapsulates premium logic and definitions for `dashboard.component.html`. | None | +| `dashboard.component.scss` | `scss` | Encapsulates premium logic and definitions for `dashboard.component.scss`. | None | +| `dashboard.component.ts` | `ts` | Encapsulates premium logic and definitions for `dashboard.component.ts`. | @angular/core, @angular/common | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate dashboard into your refined workflows: +import { /* exported members */ } from '@path/to/dashboard'; +``` diff --git a/frontend/src/pages/gallery/README.md b/frontend/src/pages/gallery/README.md new file mode 100644 index 00000000..f996fe64 --- /dev/null +++ b/frontend/src/pages/gallery/README.md @@ -0,0 +1,43 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [gallery](/frontend/src/pages/gallery) + +## 🏷️ πŸ“ Gallery + +### 🎯 PURPOSE +The `gallery` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the gallery logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + gallery[πŸ“ gallery] + gallery --> ui[πŸ–₯️ ui] + gallery --> gallery_component_html(gallery.component.html) + gallery --> gallery_component_scss(gallery.component.scss) + gallery --> gallery_component_ts(gallery.component.ts) + gallery --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery.component.html` | `html` | Encapsulates premium logic and definitions for `gallery.component.html`. | None | +| `gallery.component.scss` | `scss` | Encapsulates premium logic and definitions for `gallery.component.scss`. | None | +| `gallery.component.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.component.ts`. | @environments/environment, @shared/ui, @shared/lib/object, @angular/common, @shared/models, @angular/core, @shared/lib, @entities/gallery, @angular/forms | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@entities/gallery` +- `@environments/environment` +- `@shared/lib` +- `@shared/lib/object` +- `@shared/models` +- `@shared/ui` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate gallery into your refined workflows: +import { /* exported members */ } from '@path/to/gallery'; +``` diff --git a/frontend/src/pages/gallery/ui/README.md b/frontend/src/pages/gallery/ui/README.md new file mode 100644 index 00000000..b52751ed --- /dev/null +++ b/frontend/src/pages/gallery/ui/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [gallery](/frontend/src/pages/gallery) / [ui](/frontend/src/pages/gallery/ui) + +## 🏷️ πŸ–₯️ Ui + +### 🎯 PURPOSE +The `ui` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the ui logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + ui[πŸ–₯️ ui] + ui --> gallery-form[πŸ“ gallery-form] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate ui into your refined workflows: +import { /* exported members */ } from '@path/to/ui'; +``` diff --git a/frontend/src/pages/gallery/ui/gallery-form/README.md b/frontend/src/pages/gallery/ui/gallery-form/README.md new file mode 100644 index 00000000..1db294c1 --- /dev/null +++ b/frontend/src/pages/gallery/ui/gallery-form/README.md @@ -0,0 +1,37 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [gallery](/frontend/src/pages/gallery) / [ui](/frontend/src/pages/gallery/ui) / [gallery-form](/frontend/src/pages/gallery/ui/gallery-form) + +## 🏷️ πŸ“ Gallery-form + +### 🎯 PURPOSE +The `gallery-form` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the gallery-form logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + gallery-form[πŸ“ gallery-form] + gallery-form --> gallery_form_component_html(gallery-form.component.html) + gallery-form --> gallery_form_component_ts(gallery-form.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `gallery-form.component.html` | `html` | Encapsulates premium logic and definitions for `gallery-form.component.html`. | None | +| `gallery-form.component.ts` | `ts` | Encapsulates premium logic and definitions for `gallery-form.component.ts`. | @environments/environment, @shared/ui, @angular/common, @shared/models, @angular/core, @shared/lib, @angular/forms/signals, @features/gallery | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms/signals` +- `@environments/environment` +- `@features/gallery` +- `@shared/lib` +- `@shared/models` +- `@shared/ui` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate gallery-form into your refined workflows: +import { /* exported members */ } from '@path/to/gallery-form'; +``` diff --git a/frontend/src/pages/inventory/README.md b/frontend/src/pages/inventory/README.md new file mode 100644 index 00000000..a3a30ce4 --- /dev/null +++ b/frontend/src/pages/inventory/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [inventory](/frontend/src/pages/inventory) + +## 🏷️ πŸ“ Inventory + +### 🎯 PURPOSE +The `inventory` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the inventory logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + inventory[πŸ“ inventory] + inventory --> index_ts(index.ts) + inventory --> inventory_component_html(inventory.component.html) + inventory --> inventory_component_scss(inventory.component.scss) + inventory --> inventory_component_ts(inventory.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `inventory.component.html` | `html` | Encapsulates premium logic and definitions for `inventory.component.html`. | None | +| `inventory.component.scss` | `scss` | Encapsulates premium logic and definitions for `inventory.component.scss`. | None | +| `inventory.component.ts` | `ts` | Encapsulates premium logic and definitions for `inventory.component.ts`. | @angular/core, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate inventory into your refined workflows: +import { /* exported members */ } from '@path/to/inventory'; +``` diff --git a/frontend/src/pages/portfolio/README.md b/frontend/src/pages/portfolio/README.md new file mode 100644 index 00000000..b1a87964 --- /dev/null +++ b/frontend/src/pages/portfolio/README.md @@ -0,0 +1,37 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [portfolio](/frontend/src/pages/portfolio) + +## 🏷️ πŸ“ Portfolio + +### 🎯 PURPOSE +The `portfolio` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the portfolio logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + portfolio[πŸ“ portfolio] + portfolio --> index_ts(index.ts) + portfolio --> portfolio_component_html(portfolio.component.html) + portfolio --> portfolio_component_scss(portfolio.component.scss) + portfolio --> portfolio_component_ts(portfolio.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `portfolio.component.html` | `html` | Encapsulates premium logic and definitions for `portfolio.component.html`. | None | +| `portfolio.component.scss` | `scss` | Encapsulates premium logic and definitions for `portfolio.component.scss`. | None | +| `portfolio.component.ts` | `ts` | Encapsulates premium logic and definitions for `portfolio.component.ts`. | @shared/models, @angular/core, @entities/gallery, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@entities/gallery` +- `@shared/models` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate portfolio into your refined workflows: +import { /* exported members */ } from '@path/to/portfolio'; +``` diff --git a/frontend/src/pages/settings/README.md b/frontend/src/pages/settings/README.md new file mode 100644 index 00000000..a6bfa5f9 --- /dev/null +++ b/frontend/src/pages/settings/README.md @@ -0,0 +1,39 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [settings](/frontend/src/pages/settings) + +## 🏷️ πŸ“ Settings + +### 🎯 PURPOSE +The `settings` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the settings logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + settings[πŸ“ settings] + settings --> ui[πŸ–₯️ ui] + settings --> index_ts(index.ts) + settings --> settings_component_html(settings.component.html) + settings --> settings_component_scss(settings.component.scss) + settings --> settings_component_ts(settings.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `settings.component.html` | `html` | Encapsulates premium logic and definitions for `settings.component.html`. | None | +| `settings.component.scss` | `scss` | Encapsulates premium logic and definitions for `settings.component.scss`. | None | +| `settings.component.ts` | `ts` | Encapsulates premium logic and definitions for `settings.component.ts`. | @angular/common, @shared/models/admin-settings.model, @angular/core, @entities/admin-settings, @angular/forms | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@entities/admin-settings` +- `@shared/models/admin-settings.model` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate settings into your refined workflows: +import { /* exported members */ } from '@path/to/settings'; +``` diff --git a/frontend/src/pages/settings/ui/README.md b/frontend/src/pages/settings/ui/README.md new file mode 100644 index 00000000..2e33a2e4 --- /dev/null +++ b/frontend/src/pages/settings/ui/README.md @@ -0,0 +1,39 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [settings](/frontend/src/pages/settings) / [ui](/frontend/src/pages/settings/ui) + +## 🏷️ πŸ–₯️ Ui + +### 🎯 PURPOSE +The `ui` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the ui logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + ui[πŸ–₯️ ui] + ui --> additional_links_component_ts(additional-links.component.ts) + ui --> business_profile_component_ts(business-profile.component.ts) + ui --> general_info_component_ts(general-info.component.ts) + ui --> selects_settings_component_ts(selects-settings.component.ts) + ui --> social_matrix_component_ts(social-matrix.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `additional-links.component.ts` | `ts` | Encapsulates premium logic and definitions for `additional-links.component.ts`. | @angular/core, @angular/forms, @angular/common | +| `business-profile.component.ts` | `ts` | Encapsulates premium logic and definitions for `business-profile.component.ts`. | @shared/models, @angular/core, @angular/forms, @angular/common | +| `general-info.component.ts` | `ts` | Encapsulates premium logic and definitions for `general-info.component.ts`. | @angular/core, @angular/forms, @angular/common | +| `selects-settings.component.ts` | `ts` | Encapsulates premium logic and definitions for `selects-settings.component.ts`. | @angular/core, @angular/forms, @angular/common | +| `social-matrix.component.ts` | `ts` | Encapsulates premium logic and definitions for `social-matrix.component.ts`. | @angular/core, @angular/forms, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@shared/models` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate ui into your refined workflows: +import { /* exported members */ } from '@path/to/ui'; +``` diff --git a/frontend/src/pages/treatments-catalog/README.md b/frontend/src/pages/treatments-catalog/README.md new file mode 100644 index 00000000..174b9a02 --- /dev/null +++ b/frontend/src/pages/treatments-catalog/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [treatments-catalog](/frontend/src/pages/treatments-catalog) + +## 🏷️ πŸ“ Treatments-catalog + +### 🎯 PURPOSE +The `treatments-catalog` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the treatments-catalog logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + treatments-catalog[πŸ“ treatments-catalog] + treatments-catalog --> index_ts(index.ts) + treatments-catalog --> treatments_catalog_component_html(treatments-catalog.component.html) + treatments-catalog --> treatments_catalog_component_scss(treatments-catalog.component.scss) + treatments-catalog --> treatments_catalog_component_ts(treatments-catalog.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `treatments-catalog.component.html` | `html` | Encapsulates premium logic and definitions for `treatments-catalog.component.html`. | None | +| `treatments-catalog.component.scss` | `scss` | Encapsulates premium logic and definitions for `treatments-catalog.component.scss`. | None | +| `treatments-catalog.component.ts` | `ts` | Encapsulates premium logic and definitions for `treatments-catalog.component.ts`. | @angular/core, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate treatments-catalog into your refined workflows: +import { /* exported members */ } from '@path/to/treatments-catalog'; +``` diff --git a/frontend/src/pages/treatments/README.md b/frontend/src/pages/treatments/README.md new file mode 100644 index 00000000..112fa122 --- /dev/null +++ b/frontend/src/pages/treatments/README.md @@ -0,0 +1,42 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [treatments](/frontend/src/pages/treatments) + +## 🏷️ πŸ“ Treatments + +### 🎯 PURPOSE +The `treatments` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the treatments logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + treatments[πŸ“ treatments] + treatments --> components[🧩 components] + treatments --> index_ts(index.ts) + treatments --> treatments_component_html(treatments.component.html) + treatments --> treatments_component_scss(treatments.component.scss) + treatments --> treatments_component_ts(treatments.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `treatments.component.html` | `html` | Encapsulates premium logic and definitions for `treatments.component.html`. | None | +| `treatments.component.scss` | `scss` | Encapsulates premium logic and definitions for `treatments.component.scss`. | None | +| `treatments.component.ts` | `ts` | Encapsulates premium logic and definitions for `treatments.component.ts`. | @environments/environment, @shared/ui, @angular/common, @entities/treatments, @angular/core, @shared/lib, @angular/forms, @features/treatments | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@entities/treatments` +- `@environments/environment` +- `@features/treatments` +- `@shared/lib` +- `@shared/ui` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate treatments into your refined workflows: +import { /* exported members */ } from '@path/to/treatments'; +``` diff --git a/frontend/src/pages/treatments/components/README.md b/frontend/src/pages/treatments/components/README.md new file mode 100644 index 00000000..22276a1b --- /dev/null +++ b/frontend/src/pages/treatments/components/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [treatments](/frontend/src/pages/treatments) / [components](/frontend/src/pages/treatments/components) + +## 🏷️ 🧩 Components + +### 🎯 PURPOSE +The `components` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the components logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + components[🧩 components] + components --> treatment-form[πŸ“ treatment-form] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate components into your refined workflows: +import { /* exported members */ } from '@path/to/components'; +``` diff --git a/frontend/src/pages/treatments/components/treatment-form/README.md b/frontend/src/pages/treatments/components/treatment-form/README.md new file mode 100644 index 00000000..80a11558 --- /dev/null +++ b/frontend/src/pages/treatments/components/treatment-form/README.md @@ -0,0 +1,34 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [treatments](/frontend/src/pages/treatments) / [components](/frontend/src/pages/treatments/components) / [treatment-form](/frontend/src/pages/treatments/components/treatment-form) + +## 🏷️ πŸ“ Treatment-form + +### 🎯 PURPOSE +The `treatment-form` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the treatment-form logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + treatment-form[πŸ“ treatment-form] + treatment-form --> treatment_form_component_html(treatment-form.component.html) + treatment-form --> treatment_form_component_ts(treatment-form.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `treatment-form.component.html` | `html` | Encapsulates premium logic and definitions for `treatment-form.component.html`. | None | +| `treatment-form.component.ts` | `ts` | Encapsulates premium logic and definitions for `treatment-form.component.ts`. | @angular/common, @angular/core, @shared/lib, @angular/forms, @features/treatments | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@features/treatments` +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate treatment-form into your refined workflows: +import { /* exported members */ } from '@path/to/treatment-form'; +``` diff --git a/frontend/src/pages/user-home/README.md b/frontend/src/pages/user-home/README.md new file mode 100644 index 00000000..149a2ab8 --- /dev/null +++ b/frontend/src/pages/user-home/README.md @@ -0,0 +1,38 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [user-home](/frontend/src/pages/user-home) + +## 🏷️ πŸ“ User-home + +### 🎯 PURPOSE +The `user-home` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the user-home logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + user-home[πŸ“ user-home] + user-home --> index_ts(index.ts) + user-home --> user_home_component_html(user-home.component.html) + user-home --> user_home_component_scss(user-home.component.scss) + user-home --> user_home_component_ts(user-home.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `user-home.component.html` | `html` | Encapsulates premium logic and definitions for `user-home.component.html`. | None | +| `user-home.component.scss` | `scss` | Encapsulates premium logic and definitions for `user-home.component.scss`. | None | +| `user-home.component.ts` | `ts` | Encapsulates premium logic and definitions for `user-home.component.ts`. | @angular/common, @angular/core, @core/constants, @angular/common/http, @angular/router | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/common/http` +- `@angular/core` +- `@angular/router` +- `@core/constants` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate user-home into your refined workflows: +import { /* exported members */ } from '@path/to/user-home'; +``` diff --git a/frontend/src/pages/user-profile/README.md b/frontend/src/pages/user-profile/README.md new file mode 100644 index 00000000..466c43a2 --- /dev/null +++ b/frontend/src/pages/user-profile/README.md @@ -0,0 +1,36 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [user-profile](/frontend/src/pages/user-profile) + +## 🏷️ πŸ“ User-profile + +### 🎯 PURPOSE +The `user-profile` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the user-profile logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + user-profile[πŸ“ user-profile] + user-profile --> index_ts(index.ts) + user-profile --> user_profile_component_html(user-profile.component.html) + user-profile --> user_profile_component_scss(user-profile.component.scss) + user-profile --> user_profile_component_ts(user-profile.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `user-profile.component.html` | `html` | Encapsulates premium logic and definitions for `user-profile.component.html`. | None | +| `user-profile.component.scss` | `scss` | Encapsulates premium logic and definitions for `user-profile.component.scss`. | None | +| `user-profile.component.ts` | `ts` | Encapsulates premium logic and definitions for `user-profile.component.ts`. | @entities/user, @angular/core, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@entities/user` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate user-profile into your refined workflows: +import { /* exported members */ } from '@path/to/user-profile'; +``` diff --git a/frontend/src/pages/veil/README.md b/frontend/src/pages/veil/README.md new file mode 100644 index 00000000..fb793dc6 --- /dev/null +++ b/frontend/src/pages/veil/README.md @@ -0,0 +1,41 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [veil](/frontend/src/pages/veil) + +## 🏷️ πŸ“ Veil + +### 🎯 PURPOSE +The `veil` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veil logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veil[πŸ“ veil] + veil --> ui[πŸ–₯️ ui] + veil --> index_ts(index.ts) + veil --> veil_component_html(veil.component.html) + veil --> veil_component_scss(veil.component.scss) + veil --> veil_component_ts(veil.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `veil.component.html` | `html` | Encapsulates premium logic and definitions for `veil.component.html`. | None | +| `veil.component.scss` | `scss` | Encapsulates premium logic and definitions for `veil.component.scss`. | None | +| `veil.component.ts` | `ts` | Encapsulates premium logic and definitions for `veil.component.ts`. | @environments/environment, @shared/ui, @angular/common, @angular/core, @shared/lib, @entities/veil, @features/veil | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@entities/veil` +- `@environments/environment` +- `@features/veil` +- `@shared/lib` +- `@shared/ui` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veil into your refined workflows: +import { /* exported members */ } from '@path/to/veil'; +``` diff --git a/frontend/src/pages/veil/ui/README.md b/frontend/src/pages/veil/ui/README.md new file mode 100644 index 00000000..35789556 --- /dev/null +++ b/frontend/src/pages/veil/ui/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [veil](/frontend/src/pages/veil) / [ui](/frontend/src/pages/veil/ui) + +## 🏷️ πŸ–₯️ Ui + +### 🎯 PURPOSE +The `ui` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the ui logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + ui[πŸ–₯️ ui] + ui --> veil-form[πŸ“ veil-form] + ui --> veil-item[πŸ“ veil-item] + ui --> veil-modal[πŸ“ veil-modal] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate ui into your refined workflows: +import { /* exported members */ } from '@path/to/ui'; +``` diff --git a/frontend/src/pages/veil/ui/veil-form/README.md b/frontend/src/pages/veil/ui/veil-form/README.md new file mode 100644 index 00000000..cbb74676 --- /dev/null +++ b/frontend/src/pages/veil/ui/veil-form/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [veil](/frontend/src/pages/veil) / [ui](/frontend/src/pages/veil/ui) / [veil-form](/frontend/src/pages/veil/ui/veil-form) + +## 🏷️ πŸ“ Veil-form + +### 🎯 PURPOSE +The `veil-form` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veil-form logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veil-form[πŸ“ veil-form] + veil-form --> veil_form_component_html(veil-form.component.html) + veil-form --> veil_form_component_ts(veil-form.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil-form.component.html` | `html` | Encapsulates premium logic and definitions for `veil-form.component.html`. | None | +| `veil-form.component.ts` | `ts` | Encapsulates premium logic and definitions for `veil-form.component.ts`. | @angular/common, @angular/core, @shared/lib, @entities/veil, @angular/forms/signals, @features/veil | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms/signals` +- `@entities/veil` +- `@features/veil` +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veil-form into your refined workflows: +import { /* exported members */ } from '@path/to/veil-form'; +``` diff --git a/frontend/src/pages/veil/ui/veil-item/README.md b/frontend/src/pages/veil/ui/veil-item/README.md new file mode 100644 index 00000000..8c8e3516 --- /dev/null +++ b/frontend/src/pages/veil/ui/veil-item/README.md @@ -0,0 +1,32 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [veil](/frontend/src/pages/veil) / [ui](/frontend/src/pages/veil/ui) / [veil-item](/frontend/src/pages/veil/ui/veil-item) + +## 🏷️ πŸ“ Veil-item + +### 🎯 PURPOSE +The `veil-item` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veil-item logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veil-item[πŸ“ veil-item] + veil-item --> veil_item_component_html(veil-item.component.html) + veil-item --> veil_item_component_ts(veil-item.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil-item.component.html` | `html` | Encapsulates premium logic and definitions for `veil-item.component.html`. | None | +| `veil-item.component.ts` | `ts` | Encapsulates premium logic and definitions for `veil-item.component.ts`. | @angular/core, @features/veil, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@features/veil` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veil-item into your refined workflows: +import { /* exported members */ } from '@path/to/veil-item'; +``` diff --git a/frontend/src/pages/veil/ui/veil-modal/README.md b/frontend/src/pages/veil/ui/veil-modal/README.md new file mode 100644 index 00000000..b907ae6c --- /dev/null +++ b/frontend/src/pages/veil/ui/veil-modal/README.md @@ -0,0 +1,33 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [veil](/frontend/src/pages/veil) / [ui](/frontend/src/pages/veil/ui) / [veil-modal](/frontend/src/pages/veil/ui/veil-modal) + +## 🏷️ πŸ“ Veil-modal + +### 🎯 PURPOSE +The `veil-modal` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veil-modal logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veil-modal[πŸ“ veil-modal] + veil-modal --> veil_modal_component_html(veil-modal.component.html) + veil-modal --> veil_modal_component_ts(veil-modal.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `veil-modal.component.html` | `html` | Encapsulates premium logic and definitions for `veil-modal.component.html`. | None | +| `veil-modal.component.ts` | `ts` | Encapsulates premium logic and definitions for `veil-modal.component.ts`. | @angular/core, @angular/forms, @features/veil, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/forms` +- `@features/veil` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veil-modal into your refined workflows: +import { /* exported members */ } from '@path/to/veil-modal'; +``` diff --git a/frontend/src/pages/veils-catalog/README.md b/frontend/src/pages/veils-catalog/README.md new file mode 100644 index 00000000..43b944e8 --- /dev/null +++ b/frontend/src/pages/veils-catalog/README.md @@ -0,0 +1,36 @@ +# [frontend](/frontend) / [src](/frontend/src) / [pages](/frontend/src/pages) / [veils-catalog](/frontend/src/pages/veils-catalog) + +## 🏷️ πŸ“ Veils-catalog + +### 🎯 PURPOSE +The `veils-catalog` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the veils-catalog logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Pages** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + veils-catalog[πŸ“ veils-catalog] + veils-catalog --> index_ts(index.ts) + veils-catalog --> veils_catalog_component_html(veils-catalog.component.html) + veils-catalog --> veils_catalog_component_scss(veils-catalog.component.scss) + veils-catalog --> veils_catalog_component_ts(veils-catalog.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `veils-catalog.component.html` | `html` | Encapsulates premium logic and definitions for `veils-catalog.component.html`. | None | +| `veils-catalog.component.scss` | `scss` | Encapsulates premium logic and definitions for `veils-catalog.component.scss`. | None | +| `veils-catalog.component.ts` | `ts` | Encapsulates premium logic and definitions for `veils-catalog.component.ts`. | @angular/core, @shared/ui, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@shared/ui` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate veils-catalog into your refined workflows: +import { /* exported members */ } from '@path/to/veils-catalog'; +``` diff --git a/frontend/src/shared/README.md b/frontend/src/shared/README.md new file mode 100644 index 00000000..0438ff2a --- /dev/null +++ b/frontend/src/shared/README.md @@ -0,0 +1,33 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) + +## 🏷️ 🀝 Shared + +### 🎯 PURPOSE +The `shared` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the shared logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + shared[🀝 shared] + shared --> lib[πŸ“ lib] + shared --> models[πŸ“¦ models] + shared --> pipes[πŸ“ pipes] + shared --> services[βš™οΈ services] + shared --> store[πŸ“ store] + shared --> ui[πŸ–₯️ ui] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate shared into your refined workflows: +import { /* exported members */ } from '@path/to/shared'; +``` diff --git a/frontend/src/shared/lib/README.md b/frontend/src/shared/lib/README.md new file mode 100644 index 00000000..d3b3ef23 --- /dev/null +++ b/frontend/src/shared/lib/README.md @@ -0,0 +1,34 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [lib](/frontend/src/shared/lib) + +## 🏷️ πŸ“ Lib + +### 🎯 PURPOSE +The `lib` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the lib logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + lib[πŸ“ lib] + lib --> array_ts(array.ts) + lib --> index_ts(index.ts) + lib --> link_ts(link.ts) + lib --> object_ts(object.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `array.ts` | `ts` | Encapsulates premium logic and definitions for `array.ts`. | None | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `link.ts` | `ts` | Encapsulates premium logic and definitions for `link.ts`. | @environments/environment | +| `object.ts` | `ts` | Encapsulates premium logic and definitions for `object.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@environments/environment` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate lib into your refined workflows: +import { /* exported members */ } from '@path/to/lib'; +``` diff --git a/frontend/src/shared/models/README.md b/frontend/src/shared/models/README.md new file mode 100644 index 00000000..0189c3c8 --- /dev/null +++ b/frontend/src/shared/models/README.md @@ -0,0 +1,38 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [models](/frontend/src/shared/models) + +## 🏷️ πŸ“¦ Models + +### 🎯 PURPOSE +The `models` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the models logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + models[πŸ“¦ models] + models --> admin_settings_model_ts(admin-settings.model.ts) + models --> api_response_model_ts(api-response.model.ts) + models --> gallery_model_ts(gallery.model.ts) + models --> index_ts(index.ts) + models --> service_model_ts(service.model.ts) + models --> user_model_ts(user.model.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-settings.model.ts` | `ts` | Encapsulates premium logic and definitions for `admin-settings.model.ts`. | None | +| `api-response.model.ts` | `ts` | Encapsulates premium logic and definitions for `api-response.model.ts`. | None | +| `gallery.model.ts` | `ts` | Encapsulates premium logic and definitions for `gallery.model.ts`. | None | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `service.model.ts` | `ts` | Encapsulates premium logic and definitions for `service.model.ts`. | None | +| `user.model.ts` | `ts` | Encapsulates premium logic and definitions for `user.model.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate models into your refined workflows: +import { /* exported members */ } from '@path/to/models'; +``` diff --git a/frontend/src/shared/pipes/README.md b/frontend/src/shared/pipes/README.md new file mode 100644 index 00000000..c7dea4da --- /dev/null +++ b/frontend/src/shared/pipes/README.md @@ -0,0 +1,31 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [pipes](/frontend/src/shared/pipes) + +## 🏷️ πŸ“ Pipes + +### 🎯 PURPOSE +The `pipes` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the pipes logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + pipes[πŸ“ pipes] + pipes --> index_ts(index.ts) + pipes --> safe_html_pipe_ts(safe-html.pipe.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `safe-html.pipe.ts` | `ts` | Encapsulates premium logic and definitions for `safe-html.pipe.ts`. | @angular/core, @angular/platform-browser | + + +### πŸ”— DEPENDENCIES +- `@angular/core` +- `@angular/platform-browser` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate pipes into your refined workflows: +import { /* exported members */ } from '@path/to/pipes'; +``` diff --git a/frontend/src/shared/services/README.md b/frontend/src/shared/services/README.md new file mode 100644 index 00000000..78b8eb09 --- /dev/null +++ b/frontend/src/shared/services/README.md @@ -0,0 +1,41 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [services](/frontend/src/shared/services) + +## 🏷️ βš™οΈ Services + +### 🎯 PURPOSE +The `services` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the services logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + services[βš™οΈ services] + services --> auth_service_ts(auth.service.ts) + services --> error_service_ts(error.service.ts) + services --> image_service_ts(image.service.ts) + services --> index_ts(index.ts) + services --> telegram_service_ts(telegram.service.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `auth.service.ts` | `ts` | Encapsulates premium logic and definitions for `auth.service.ts`. | @shared/models, @angular/core, @core/constants, @angular/common/http, @angular/router | +| `error.service.ts` | `ts` | Encapsulates premium logic and definitions for `error.service.ts`. | @angular/core | +| `image.service.ts` | `ts` | Encapsulates premium logic and definitions for `image.service.ts`. | @angular/core | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `telegram.service.ts` | `ts` | Encapsulates premium logic and definitions for `telegram.service.ts`. | @src/types/telegram, @angular/core | + + +### πŸ”— DEPENDENCIES +- `@angular/common/http` +- `@angular/core` +- `@angular/router` +- `@core/constants` +- `@shared/models` +- `@src/types/telegram` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate services into your refined workflows: +import { /* exported members */ } from '@path/to/services'; +``` diff --git a/frontend/src/shared/store/README.md b/frontend/src/shared/store/README.md new file mode 100644 index 00000000..564e2877 --- /dev/null +++ b/frontend/src/shared/store/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [store](/frontend/src/shared/store) + +## 🏷️ πŸ“ Store + +### 🎯 PURPOSE +The `store` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the store logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + store[πŸ“ store] + store --> index_ts(index.ts) + store --> signal_store_base_ts(signal-store.base.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `signal-store.base.ts` | `ts` | Encapsulates premium logic and definitions for `signal-store.base.ts`. | @angular/core | + + +### πŸ”— DEPENDENCIES +- `@angular/core` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate store into your refined workflows: +import { /* exported members */ } from '@path/to/store'; +``` diff --git a/frontend/src/shared/ui/README.md b/frontend/src/shared/ui/README.md new file mode 100644 index 00000000..05867557 --- /dev/null +++ b/frontend/src/shared/ui/README.md @@ -0,0 +1,32 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [ui](/frontend/src/shared/ui) + +## 🏷️ πŸ–₯️ Ui + +### 🎯 PURPOSE +The `ui` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the ui logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + ui[πŸ–₯️ ui] + ui --> card-view[πŸ“ card-view] + ui --> global-error[πŸ“ global-error] + ui --> image-popup[πŸ“ image-popup] + ui --> list-view[πŸ“ list-view] + ui --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate ui into your refined workflows: +import { /* exported members */ } from '@path/to/ui'; +``` diff --git a/frontend/src/shared/ui/card-view/README.md b/frontend/src/shared/ui/card-view/README.md new file mode 100644 index 00000000..97f0c748 --- /dev/null +++ b/frontend/src/shared/ui/card-view/README.md @@ -0,0 +1,37 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [ui](/frontend/src/shared/ui) / [card-view](/frontend/src/shared/ui/card-view) + +## 🏷️ πŸ“ Card-view + +### 🎯 PURPOSE +The `card-view` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the card-view logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + card-view[πŸ“ card-view] + card-view --> card_view_component_html(card-view.component.html) + card-view --> card_view_component_scss(card-view.component.scss) + card-view --> card_view_component_ts(card-view.component.ts) + card-view --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `card-view.component.html` | `html` | Encapsulates premium logic and definitions for `card-view.component.html`. | None | +| `card-view.component.scss` | `scss` | Encapsulates premium logic and definitions for `card-view.component.scss`. | None | +| `card-view.component.ts` | `ts` | Encapsulates premium logic and definitions for `card-view.component.ts`. | @environments/environment, @angular/core, @shared/lib, @angular/common | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@environments/environment` +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate card-view into your refined workflows: +import { /* exported members */ } from '@path/to/card-view'; +``` diff --git a/frontend/src/shared/ui/global-error/README.md b/frontend/src/shared/ui/global-error/README.md new file mode 100644 index 00000000..883c7015 --- /dev/null +++ b/frontend/src/shared/ui/global-error/README.md @@ -0,0 +1,31 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [ui](/frontend/src/shared/ui) / [global-error](/frontend/src/shared/ui/global-error) + +## 🏷️ πŸ“ Global-error + +### 🎯 PURPOSE +The `global-error` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the global-error logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + global-error[πŸ“ global-error] + global-error --> global_error_component_ts(global-error.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `global-error.component.ts` | `ts` | Encapsulates premium logic and definitions for `global-error.component.ts`. | @angular/core, @shared/services, @angular/animations, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/animations` +- `@angular/common` +- `@angular/core` +- `@shared/services` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate global-error into your refined workflows: +import { /* exported members */ } from '@path/to/global-error'; +``` diff --git a/frontend/src/shared/ui/image-popup/README.md b/frontend/src/shared/ui/image-popup/README.md new file mode 100644 index 00000000..5e5566b2 --- /dev/null +++ b/frontend/src/shared/ui/image-popup/README.md @@ -0,0 +1,31 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [ui](/frontend/src/shared/ui) / [image-popup](/frontend/src/shared/ui/image-popup) + +## 🏷️ πŸ“ Image-popup + +### 🎯 PURPOSE +The `image-popup` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the image-popup logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + image-popup[πŸ“ image-popup] + image-popup --> image_popup_component_html(image-popup.component.html) + image-popup --> image_popup_component_ts(image-popup.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `image-popup.component.html` | `html` | Encapsulates premium logic and definitions for `image-popup.component.html`. | None | +| `image-popup.component.ts` | `ts` | Encapsulates premium logic and definitions for `image-popup.component.ts`. | @angular/core, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate image-popup into your refined workflows: +import { /* exported members */ } from '@path/to/image-popup'; +``` diff --git a/frontend/src/shared/ui/list-view/README.md b/frontend/src/shared/ui/list-view/README.md new file mode 100644 index 00000000..2a2e520c --- /dev/null +++ b/frontend/src/shared/ui/list-view/README.md @@ -0,0 +1,34 @@ +# [frontend](/frontend) / [src](/frontend/src) / [shared](/frontend/src/shared) / [ui](/frontend/src/shared/ui) / [list-view](/frontend/src/shared/ui/list-view) + +## 🏷️ πŸ“ List-view + +### 🎯 PURPOSE +The `list-view` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the list-view logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Shared** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + list-view[πŸ“ list-view] + list-view --> list_view_component_html(list-view.component.html) + list-view --> list_view_component_scss(list-view.component.scss) + list-view --> list_view_component_ts(list-view.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `list-view.component.html` | `html` | Encapsulates premium logic and definitions for `list-view.component.html`. | None | +| `list-view.component.scss` | `scss` | Encapsulates premium logic and definitions for `list-view.component.scss`. | None | +| `list-view.component.ts` | `ts` | Encapsulates premium logic and definitions for `list-view.component.ts`. | @angular/core, @shared/lib, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@shared/lib` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate list-view into your refined workflows: +import { /* exported members */ } from '@path/to/list-view'; +``` diff --git a/frontend/src/types/README.md b/frontend/src/types/README.md new file mode 100644 index 00000000..5bda4a18 --- /dev/null +++ b/frontend/src/types/README.md @@ -0,0 +1,28 @@ +# [frontend](/frontend) / [src](/frontend/src) / [types](/frontend/src/types) + +## 🏷️ πŸ“ Types + +### 🎯 PURPOSE +The `types` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the types logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + types[πŸ“ types] + types --> telegram_ts(telegram.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `telegram.ts` | `ts` | Encapsulates premium logic and definitions for `telegram.ts`. | None | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate types into your refined workflows: +import { /* exported members */ } from '@path/to/types'; +``` diff --git a/frontend/src/widgets/README.md b/frontend/src/widgets/README.md new file mode 100644 index 00000000..550976b4 --- /dev/null +++ b/frontend/src/widgets/README.md @@ -0,0 +1,30 @@ +# [frontend](/frontend) / [src](/frontend/src) / [widgets](/frontend/src/widgets) + +## 🏷️ πŸͺŸ Widgets + +### 🎯 PURPOSE +The `widgets` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the widgets logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Widgets** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + widgets[πŸͺŸ widgets] + widgets --> header[πŸ” header] + widgets --> layouts[πŸ“ layouts] + widgets --> sidebar[🧭 sidebar] +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| *No exclusive files* | - | Architecturally reserved | - | + + +### πŸ”— DEPENDENCIES +- *Self-contained premium module.* + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate widgets into your refined workflows: +import { /* exported members */ } from '@path/to/widgets'; +``` diff --git a/frontend/src/widgets/header/README.md b/frontend/src/widgets/header/README.md new file mode 100644 index 00000000..8d668310 --- /dev/null +++ b/frontend/src/widgets/header/README.md @@ -0,0 +1,37 @@ +# [frontend](/frontend) / [src](/frontend/src) / [widgets](/frontend/src/widgets) / [header](/frontend/src/widgets/header) + +## 🏷️ πŸ” Header + +### 🎯 PURPOSE +The `header` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the header logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Widgets** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + header[πŸ” header] + header --> header_component_html(header.component.html) + header --> header_component_scss(header.component.scss) + header --> header_component_ts(header.component.ts) + header --> index_ts(index.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `header.component.html` | `html` | Encapsulates premium logic and definitions for `header.component.html`. | None | +| `header.component.scss` | `scss` | Encapsulates premium logic and definitions for `header.component.scss`. | None | +| `header.component.ts` | `ts` | Encapsulates premium logic and definitions for `header.component.ts`. | @angular/core, @features/language-selection, @angular/router, @angular/common | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/router` +- `@features/language-selection` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate header into your refined workflows: +import { /* exported members */ } from '@path/to/header'; +``` diff --git a/frontend/src/widgets/layouts/README.md b/frontend/src/widgets/layouts/README.md new file mode 100644 index 00000000..9e7b1527 --- /dev/null +++ b/frontend/src/widgets/layouts/README.md @@ -0,0 +1,44 @@ +# [frontend](/frontend) / [src](/frontend/src) / [widgets](/frontend/src/widgets) / [layouts](/frontend/src/widgets/layouts) + +## 🏷️ πŸ“ Layouts + +### 🎯 PURPOSE +The `layouts` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the layouts logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Widgets** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + layouts[πŸ“ layouts] + layouts --> admin_layout_component_html(admin-layout.component.html) + layouts --> admin_layout_component_scss(admin-layout.component.scss) + layouts --> admin_layout_component_ts(admin-layout.component.ts) + layouts --> index_ts(index.ts) + layouts --> user_layout_component_html(user-layout.component.html) + layouts --> user_layout_component_scss(user-layout.component.scss) + layouts --> user_layout_component_ts(user-layout.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `admin-layout.component.html` | `html` | Encapsulates premium logic and definitions for `admin-layout.component.html`. | None | +| `admin-layout.component.scss` | `scss` | Encapsulates premium logic and definitions for `admin-layout.component.scss`. | None | +| `admin-layout.component.ts` | `ts` | Encapsulates premium logic and definitions for `admin-layout.component.ts`. | @angular/core, @widgets/sidebar, @widgets/header, @angular/router | +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `user-layout.component.html` | `html` | Encapsulates premium logic and definitions for `user-layout.component.html`. | None | +| `user-layout.component.scss` | `scss` | Encapsulates premium logic and definitions for `user-layout.component.scss`. | None | +| `user-layout.component.ts` | `ts` | Encapsulates premium logic and definitions for `user-layout.component.ts`. | @angular/core, @angular/router, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/router` +- `@widgets/header` +- `@widgets/sidebar` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate layouts into your refined workflows: +import { /* exported members */ } from '@path/to/layouts'; +``` diff --git a/frontend/src/widgets/sidebar/README.md b/frontend/src/widgets/sidebar/README.md new file mode 100644 index 00000000..7a44ee7d --- /dev/null +++ b/frontend/src/widgets/sidebar/README.md @@ -0,0 +1,35 @@ +# [frontend](/frontend) / [src](/frontend/src) / [widgets](/frontend/src/widgets) / [sidebar](/frontend/src/widgets/sidebar) + +## 🏷️ 🧭 Sidebar + +### 🎯 PURPOSE +The `sidebar` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the sidebar logic to ensure a seamless and premium experience. Integrated within our cutting-edge Angular frontend architecture, it crafts an elegant, highly-responsive user interface reflecting our luxury brand standards. This module is a distinguished component of the **Widgets** layer under the Feature Sliced Design (FSD) methodology. + +### πŸ—οΈ ARCHITECTURE +```mermaid +graph TD + sidebar[🧭 sidebar] + sidebar --> index_ts(index.ts) + sidebar --> sidebar_component_html(sidebar.component.html) + sidebar --> sidebar_component_ts(sidebar.component.ts) +``` + +### πŸ“„ FILE REGISTRY +| File Name | Type | Responsibility | Key Aliases Used | +|---|---|---|---| +| `index.ts` | `ts` | Encapsulates premium logic and definitions for `index.ts`. | None | +| `sidebar.component.html` | `html` | Encapsulates premium logic and definitions for `sidebar.component.html`. | None | +| `sidebar.component.ts` | `ts` | Encapsulates premium logic and definitions for `sidebar.component.ts`. | @angular/core, @shared/pipes, @angular/router, @angular/common | + + +### πŸ”— DEPENDENCIES +- `@angular/common` +- `@angular/core` +- `@angular/router` +- `@shared/pipes` + +### πŸ› οΈ USAGE +```typescript +// Seamlessly integrate sidebar into your refined workflows: +import { /* exported members */ } from '@path/to/sidebar'; +```