Skip to content

Commit e0fb9ce

Browse files
beginwebdev2002beginwebdev2002
authored
Merge pull request #15 from beginwebdev2002/docs/generate-all-readmes-16357318049280193089
docs: generate localized, brand-compliant READMEs for all project directories
2 parents 626693d + fe9301d commit e0fb9ce

156 files changed

Lines changed: 1675 additions & 1438 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,6 @@ dist-ssr
3737
!README.md
3838
!GEMINI.md
3939
!AGENTS.md
40+
# Stop gitignore errors
41+
!README.md
42+
!**/README.md

‎README.md‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,27 @@ The `root` directory forms a critical foundation within the Mavluda Beauty ecosy
99
```mermaid
1010
graph TD
1111
root[📁 root]
12-
root --> backend[📁 backend]
13-
root --> frontend[📁 frontend]
14-
root --> _env(.env)
15-
root --> _gitignore(.gitignore)
16-
root --> GEMINI_md(GEMINI.md)
17-
root --> generate_all_readmes_py(generate_all_readmes.py)
18-
root --> generate_all_readmes_refined_py(generate_all_readmes_refined.py)
19-
root --> generate_readme_py(generate_readme.py)
12+
root --> root_backend[📁 backend]
13+
root --> root_frontend[📁 frontend]
14+
root --> root__env(.env)
15+
root --> root__gitignore(.gitignore)
16+
root --> root__gitignore_append(.gitignore_append)
17+
root --> root_GEMINI_md(GEMINI.md)
18+
root --> root_generate_readmes_py(generate_readmes.py)
2019
```
2120

2221
### 📄 FILE REGISTRY
2322
| File Name | Type | Responsibility | Key Aliases Used |
2423
|---|---|---|---|
2524
| `.env` | `env` | Configuration and foundational asset. | None |
2625
| `.gitignore` | `gitignore` | Configuration and foundational asset. | None |
26+
| `.gitignore_append` | `gitignore_append` | Configuration and foundational asset. | None |
2727
| `GEMINI.md` | `md` | Configuration and foundational asset. | None |
28-
| `generate_all_readmes.py` | `py` | Configuration and foundational asset. | None |
29-
| `generate_all_readmes_refined.py` | `py` | Configuration and foundational asset. | None |
30-
| `generate_readme.py` | `py` | Configuration and foundational asset. | None |
31-
28+
| `generate_readmes.py` | `py` | Configuration and foundational asset. | @path |
3229

3330
### 🔗 DEPENDENCIES
34-
- *Self-contained premium module.*
31+
- `...`
32+
- `@path/to/{dirname}`
3533

3634
### 🛠️ USAGE
3735
```typescript

‎backend/README.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,41 @@
1-
# [backend](/backend)
1+
# [root](/) / [backend](/backend)
22

33
## 🏷️ 📁 Backend
44

55
### 🎯 PURPOSE
6-
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.
6+
The `backend` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the backend logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
1111
backend[📁 backend]
12-
backend --> src[📁 src]
13-
backend --> test[📁 test]
14-
backend --> _prettierrc(.prettierrc)
15-
backend --> eslint_config_mjs(eslint.config.mjs)
16-
backend --> nest_cli_json(nest-cli.json)
17-
backend --> package_lock_json(package-lock.json)
18-
backend --> package_json(package.json)
19-
backend --> tsconfig_build_json(tsconfig.build.json)
20-
backend --> tsconfig_json(tsconfig.json)
12+
backend --> backend_src[📁 src]
13+
backend --> backend_test[📁 test]
14+
backend --> backend__prettierrc(.prettierrc)
15+
backend --> backend_eslint_config_mjs(eslint.config.mjs)
16+
backend --> backend_nest_cli_json(nest-cli.json)
17+
backend --> backend_package_lock_json(package-lock.json)
18+
backend --> backend_package_json(package.json)
19+
backend --> backend_tsconfig_build_json(tsconfig.build.json)
20+
backend --> backend_tsconfig_json(tsconfig.json)
2121
```
2222

2323
### 📄 FILE REGISTRY
2424
| File Name | Type | Responsibility | Key Aliases Used |
2525
|---|---|---|---|
2626
| `.prettierrc` | `prettierrc` | Configuration and foundational asset. | None |
27-
| `eslint.config.mjs` | `mjs` | Configuration and foundational asset. | None |
27+
| `eslint.config.mjs` | `mjs` | Configuration and foundational asset. | @eslint |
2828
| `nest-cli.json` | `json` | Configuration and foundational asset. | None |
2929
| `package-lock.json` | `json` | Configuration and foundational asset. | None |
3030
| `package.json` | `json` | Configuration and foundational asset. | None |
3131
| `tsconfig.build.json` | `json` | Configuration and foundational asset. | None |
3232
| `tsconfig.json` | `json` | Configuration and foundational asset. | None |
3333

34-
3534
### 🔗 DEPENDENCIES
36-
- *Self-contained premium module.*
35+
- `@eslint/js`
36+
- `eslint-plugin-prettier/recommended`
37+
- `globals`
38+
- `typescript-eslint`
3739

3840
### 🛠️ USAGE
3941
```typescript

‎backend/src/README.md‎

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,44 @@
1-
# [backend](/backend) / [src](/backend/src)
1+
# [root](/) / [backend](/backend) / [src](/backend/src)
22

33
## 🏷️ 📁 Src
44

55
### 🎯 PURPOSE
6-
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.
6+
The `src` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the src logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
1111
src[📁 src]
12-
src --> common[📁 common]
13-
src --> modules[📦 modules]
14-
src --> app_controller_spec_ts(app.controller.spec.ts)
15-
src --> app_controller_ts(app.controller.ts)
16-
src --> app_module_ts(app.module.ts)
17-
src --> app_service_ts(app.service.ts)
18-
src --> main_ts(main.ts)
12+
src --> src_common[📁 common]
13+
src --> src_modules[📁 modules]
14+
src --> src_app_controller_spec_ts(app.controller.spec.ts)
15+
src --> src_app_controller_ts(app.controller.ts)
16+
src --> src_app_module_ts(app.module.ts)
17+
src --> src_app_service_ts(app.service.ts)
18+
src --> src_main_ts(main.ts)
1919
```
2020

2121
### 📄 FILE REGISTRY
2222
| File Name | Type | Responsibility | Key Aliases Used |
2323
|---|---|---|---|
24-
| `app.controller.spec.ts` | `ts` | Encapsulates premium logic and definitions for `app.controller.spec.ts`. | @nestjs/testing |
25-
| `app.controller.ts` | `ts` | Encapsulates premium logic and definitions for `app.controller.ts`. | @nestjs/common |
26-
| `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 |
27-
| `app.service.ts` | `ts` | Encapsulates premium logic and definitions for `app.service.ts`. | @nestjs/common |
28-
| `main.ts` | `ts` | Encapsulates premium logic and definitions for `main.ts`. | @nestjs/config, @nestjs/common, @nestjs/core |
29-
24+
| `app.controller.spec.ts` | `ts` | Handles incoming HTTP requests. | @nestjs |
25+
| `app.controller.ts` | `ts` | Handles incoming HTTP requests. | @nestjs |
26+
| `app.module.ts` | `ts` | Module configuration and provider registration. | @modules, @nestjs |
27+
| `app.service.ts` | `ts` | Business logic and service layer. | @nestjs |
28+
| `main.ts` | `ts` | Core logic implementation. | @nestjs |
3029

3130
### 🔗 DEPENDENCIES
31+
- `./app.controller`
32+
- `./app.module`
33+
- `./app.service`
34+
- `./common/config/app-config.module`
35+
- `./common/database/database.module`
3236
- `@modules/admin-settings`
3337
- `@modules/auth`
3438
- `@modules/booking`
3539
- `@modules/gallery`
3640
- `@modules/inventory`
37-
- `@modules/partnership`
38-
- `@modules/payment`
39-
- `@modules/treatments`
40-
- `@modules/user`
41-
- `@modules/veil`
42-
- `@nestjs/common`
43-
- `@nestjs/config`
44-
- `@nestjs/core`
45-
- `@nestjs/serve-static`
46-
- `@nestjs/testing`
41+
- *...and more.*
4742

4843
### 🛠️ USAGE
4944
```typescript

‎backend/src/common/README.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1-
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common)
1+
# [root](/) / [backend](/backend) / [src](/backend/src) / [common](/backend/src/common)
22

33
## 🏷️ 📁 Common
44

55
### 🎯 PURPOSE
6-
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.
6+
The `common` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the common logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
1111
common[📁 common]
12-
common --> config[🛠️ config]
13-
common --> database[💾 database]
14-
common --> decorators[✨ decorators]
15-
common --> guards[🛡️ guards]
16-
common --> interfaces[🔌 interfaces]
17-
common --> utils[🧰 utils]
12+
common --> common_config[📁 config]
13+
common --> common_database[📁 database]
14+
common --> common_decorators[📁 decorators]
15+
common --> common_guards[📁 guards]
16+
common --> common_interfaces[📁 interfaces]
17+
common --> common_utils[📁 utils]
1818
```
1919

2020
### 📄 FILE REGISTRY
2121
| File Name | Type | Responsibility | Key Aliases Used |
2222
|---|---|---|---|
23-
| *No exclusive files* | - | Architecturally reserved | - |
24-
23+
| *No files* | `-` | *Directory is strictly structural.* | `-` |
2524

2625
### 🔗 DEPENDENCIES
2726
- *Self-contained premium module.*

‎backend/src/common/config/README.md‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,36 @@
1-
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [config](/backend/src/common/config)
1+
# [root](/) / [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [config](/backend/src/common/config)
22

3-
## 🏷️ 🛠️ Config
3+
## 🏷️ 📁 Config
44

55
### 🎯 PURPOSE
6-
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.
6+
The `config` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the config logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
11-
config[🛠️ config]
12-
config --> app_config_module_ts(app-config.module.ts)
13-
config --> app_config_service_ts(app-config.service.ts)
14-
config --> configuration_ts(configuration.ts)
15-
config --> env_validation_ts(env.validation.ts)
11+
config[📁 config]
12+
config --> config_app_config_module_ts(app-config.module.ts)
13+
config --> config_app_config_service_ts(app-config.service.ts)
14+
config --> config_configuration_ts(configuration.ts)
15+
config --> config_env_validation_ts(env.validation.ts)
1616
```
1717

1818
### 📄 FILE REGISTRY
1919
| File Name | Type | Responsibility | Key Aliases Used |
2020
|---|---|---|---|
21-
| `app-config.module.ts` | `ts` | Encapsulates premium logic and definitions for `app-config.module.ts`. | @nestjs/config, @nestjs/common |
22-
| `app-config.service.ts` | `ts` | Encapsulates premium logic and definitions for `app-config.service.ts`. | @nestjs/config, @nestjs/common |
23-
| `configuration.ts` | `ts` | Encapsulates premium logic and definitions for `configuration.ts`. | None |
24-
| `env.validation.ts` | `ts` | Encapsulates premium logic and definitions for `env.validation.ts`. | None |
25-
21+
| `app-config.module.ts` | `ts` | Module configuration and provider registration. | @nestjs |
22+
| `app-config.service.ts` | `ts` | Business logic and service layer. | @nestjs |
23+
| `configuration.ts` | `ts` | Core logic implementation. | None |
24+
| `env.validation.ts` | `ts` | Core logic implementation. | None |
2625

2726
### 🔗 DEPENDENCIES
27+
- `./app-config.service`
28+
- `./configuration`
29+
- `./env.validation`
2830
- `@nestjs/common`
2931
- `@nestjs/config`
32+
- `class-transformer`
33+
- `class-validator`
3034

3135
### 🛠️ USAGE
3236
```typescript

‎backend/src/common/database/README.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1-
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [database](/backend/src/common/database)
1+
# [root](/) / [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [database](/backend/src/common/database)
22

3-
## 🏷️ 💾 Database
3+
## 🏷️ 📁 Database
44

55
### 🎯 PURPOSE
6-
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.
6+
The `database` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the database logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
11-
database[💾 database]
12-
database --> database_module_ts(database.module.ts)
11+
database[📁 database]
12+
database --> database_database_module_ts(database.module.ts)
1313
```
1414

1515
### 📄 FILE REGISTRY
1616
| File Name | Type | Responsibility | Key Aliases Used |
1717
|---|---|---|---|
18-
| `database.module.ts` | `ts` | Encapsulates premium logic and definitions for `database.module.ts`. | @nestjs/config, @nestjs/common, @nestjs/mongoose |
19-
18+
| `database.module.ts` | `ts` | Module configuration and provider registration. | @nestjs |
2019

2120
### 🔗 DEPENDENCIES
2221
- `@nestjs/common`

‎backend/src/common/decorators/README.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
1-
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [decorators](/backend/src/common/decorators)
1+
# [root](/) / [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [decorators](/backend/src/common/decorators)
22

3-
## 🏷️ ✨ Decorators
3+
## 🏷️ 📁 Decorators
44

55
### 🎯 PURPOSE
6-
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.
6+
The `decorators` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the decorators logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
11-
decorators[✨ decorators]
12-
decorators --> public_decorator_ts(public.decorator.ts)
13-
decorators --> roles_decorator_ts(roles.decorator.ts)
11+
decorators[📁 decorators]
12+
decorators --> decorators_public_decorator_ts(public.decorator.ts)
13+
decorators --> decorators_roles_decorator_ts(roles.decorator.ts)
1414
```
1515

1616
### 📄 FILE REGISTRY
1717
| File Name | Type | Responsibility | Key Aliases Used |
1818
|---|---|---|---|
19-
| `public.decorator.ts` | `ts` | Encapsulates premium logic and definitions for `public.decorator.ts`. | @nestjs/common |
20-
| `roles.decorator.ts` | `ts` | Encapsulates premium logic and definitions for `roles.decorator.ts`. | @nestjs/common |
21-
19+
| `public.decorator.ts` | `ts` | Core logic implementation. | @nestjs |
20+
| `roles.decorator.ts` | `ts` | Core logic implementation. | @nestjs |
2221

2322
### 🔗 DEPENDENCIES
2423
- `@nestjs/common`

‎backend/src/common/guards/README.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [guards](/backend/src/common/guards)
1+
# [root](/) / [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [guards](/backend/src/common/guards)
22

3-
## 🏷️ 🛡️ Guards
3+
## 🏷️ 📁 Guards
44

55
### 🎯 PURPOSE
6-
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.
6+
The `guards` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the guards logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
11-
guards[🛡️ guards]
12-
guards --> jwt_auth_guard_ts(jwt-auth.guard.ts)
13-
guards --> roles_guard_ts(roles.guard.ts)
11+
guards[📁 guards]
12+
guards --> guards_jwt_auth_guard_ts(jwt-auth.guard.ts)
13+
guards --> guards_roles_guard_ts(roles.guard.ts)
1414
```
1515

1616
### 📄 FILE REGISTRY
1717
| File Name | Type | Responsibility | Key Aliases Used |
1818
|---|---|---|---|
19-
| `jwt-auth.guard.ts` | `ts` | Encapsulates premium logic and definitions for `jwt-auth.guard.ts`. | @nestjs/passport, @nestjs/common, @nestjs/core |
20-
| `roles.guard.ts` | `ts` | Encapsulates premium logic and definitions for `roles.guard.ts`. | @nestjs/common, @nestjs/core |
21-
19+
| `jwt-auth.guard.ts` | `ts` | Core logic implementation. | @nestjs |
20+
| `roles.guard.ts` | `ts` | Core logic implementation. | @nestjs |
2221

2322
### 🔗 DEPENDENCIES
23+
- `../decorators/public.decorator`
24+
- `../decorators/roles.decorator`
2425
- `@nestjs/common`
2526
- `@nestjs/core`
2627
- `@nestjs/passport`

‎backend/src/common/interfaces/README.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
1-
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [interfaces](/backend/src/common/interfaces)
1+
# [root](/) / [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [interfaces](/backend/src/common/interfaces)
22

3-
## 🏷️ 🔌 Interfaces
3+
## 🏷️ 📁 Interfaces
44

55
### 🎯 PURPOSE
6-
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.
6+
The `interfaces` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the interfaces logic to ensure a seamless and premium experience.
77

88
### 🏗️ ARCHITECTURE
99
```mermaid
1010
graph TD
11-
interfaces[🔌 interfaces]
12-
interfaces --> authenticated_request_interface_ts(authenticated-request.interface.ts)
11+
interfaces[📁 interfaces]
12+
interfaces --> interfaces_authenticated_request_interface_ts(authenticated-request.interface.ts)
1313
```
1414

1515
### 📄 FILE REGISTRY
1616
| File Name | Type | Responsibility | Key Aliases Used |
1717
|---|---|---|---|
18-
| `authenticated-request.interface.ts` | `ts` | Encapsulates premium logic and definitions for `authenticated-request.interface.ts`. | None |
19-
18+
| `authenticated-request.interface.ts` | `ts` | Core logic implementation. | None |
2019

2120
### 🔗 DEPENDENCIES
22-
- *Self-contained premium module.*
21+
- `express`
2322

2423
### 🛠️ USAGE
2524
```typescript

0 commit comments

Comments
 (0)