Skip to content

Commit 141eca1

Browse files
chore(docs): auto-generate recursive localized READMEs
- Autogenerated localized `README.md` files for every directory. - Added contextual Emojis and Hierarchy to all titles. - Added Breadcrumb Navigation. - Added Mermaid.js architectural diagrams based on contents. - Added Markdown Tables tracking file contents and alias usage. - Added dependencies list. - Ignored root-level stray `*.md` files in `.gitignore` to maintain repo cleanliness while ensuring `.md` exceptions for the core standard `README.md`. - Adhered to the luxury brand tone across all files. Co-authored-by: beginwebdev2002 <102213457+beginwebdev2002@users.noreply.github.com>
1 parent 780d06b commit 141eca1

157 files changed

Lines changed: 4986 additions & 114 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: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,7 @@ dist-ssr
3333
*.njsproj
3434
*.sln
3535
*.sw?
36+
*.md
37+
!README.md
38+
!GEMINI.md
39+
!AGENTS.md

.gitignore_append

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.md
2+
!README.md
3+
!GEMINI.md
4+
!AGENTS.md

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# [root](/)
2+
3+
## 🏷️ 📁 Root
4+
5+
### 🎯 PURPOSE
6+
The `root` directory forms a critical foundation within the Mavluda Beauty ecosystem, meticulously orchestrating the root logic to ensure a seamless and premium experience.
7+
8+
### 🏗️ ARCHITECTURE
9+
```mermaid
10+
graph TD
11+
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)
20+
```
21+
22+
### 📄 FILE REGISTRY
23+
| File Name | Type | Responsibility | Key Aliases Used |
24+
|---|---|---|---|
25+
| `.env` | `env` | Configuration and foundational asset. | None |
26+
| `.gitignore` | `gitignore` | Configuration and foundational asset. | None |
27+
| `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+
32+
33+
### 🔗 DEPENDENCIES
34+
- *Self-contained premium module.*
35+
36+
### 🛠️ USAGE
37+
```typescript
38+
// Seamlessly integrate root into your refined workflows:
39+
import { /* exported members */ } from '@path/to/root';
40+
```

backend/README.md

Lines changed: 39 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,42 @@
1-
<p align="center">
2-
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
3-
</p>
4-
5-
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
6-
[circleci-url]: https://circleci.com/gh/nestjs/nest
7-
8-
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
9-
<p align="center">
10-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
11-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
12-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
13-
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
14-
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
15-
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
16-
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
17-
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
18-
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
19-
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
20-
</p>
21-
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
22-
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
23-
24-
## Description
25-
26-
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
27-
28-
## Project setup
29-
30-
```bash
31-
$ npm install
1+
# [backend](/backend)
2+
3+
## 🏷️ 📁 Backend
4+
5+
### 🎯 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.
7+
8+
### 🏗️ ARCHITECTURE
9+
```mermaid
10+
graph TD
11+
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)
3221
```
3322

34-
## Compile and run the project
35-
36-
```bash
37-
# development
38-
$ npm run start
39-
40-
# watch mode
41-
$ npm run start:dev
42-
43-
# production mode
44-
$ npm run start:prod
23+
### 📄 FILE REGISTRY
24+
| File Name | Type | Responsibility | Key Aliases Used |
25+
|---|---|---|---|
26+
| `.prettierrc` | `prettierrc` | Configuration and foundational asset. | None |
27+
| `eslint.config.mjs` | `mjs` | Configuration and foundational asset. | None |
28+
| `nest-cli.json` | `json` | Configuration and foundational asset. | None |
29+
| `package-lock.json` | `json` | Configuration and foundational asset. | None |
30+
| `package.json` | `json` | Configuration and foundational asset. | None |
31+
| `tsconfig.build.json` | `json` | Configuration and foundational asset. | None |
32+
| `tsconfig.json` | `json` | Configuration and foundational asset. | None |
33+
34+
35+
### 🔗 DEPENDENCIES
36+
- *Self-contained premium module.*
37+
38+
### 🛠️ USAGE
39+
```typescript
40+
// Seamlessly integrate backend into your refined workflows:
41+
import { /* exported members */ } from '@path/to/backend';
4542
```
46-
47-
## Run tests
48-
49-
```bash
50-
# unit tests
51-
$ npm run test
52-
53-
# e2e tests
54-
$ npm run test:e2e
55-
56-
# test coverage
57-
$ npm run test:cov
58-
```
59-
60-
## Deployment
61-
62-
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.
63-
64-
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:
65-
66-
```bash
67-
$ npm install -g @nestjs/mau
68-
$ mau deploy
69-
```
70-
71-
With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
72-
73-
## Resources
74-
75-
Check out a few resources that may come in handy when working with NestJS:
76-
77-
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
78-
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
79-
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
80-
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
81-
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
82-
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
83-
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
84-
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
85-
86-
## Support
87-
88-
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).
89-
90-
## Stay in touch
91-
92-
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
93-
- Website - [https://nestjs.com](https://nestjs.com/)
94-
- Twitter - [@nestframework](https://twitter.com/nestframework)
95-
96-
## License
97-
98-
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).

backend/src/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# [backend](/backend) / [src](/backend/src)
2+
3+
## 🏷️ 📁 Src
4+
5+
### 🎯 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.
7+
8+
### 🏗️ ARCHITECTURE
9+
```mermaid
10+
graph TD
11+
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)
19+
```
20+
21+
### 📄 FILE REGISTRY
22+
| File Name | Type | Responsibility | Key Aliases Used |
23+
|---|---|---|---|
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+
30+
31+
### 🔗 DEPENDENCIES
32+
- `@modules/admin-settings`
33+
- `@modules/auth`
34+
- `@modules/booking`
35+
- `@modules/gallery`
36+
- `@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`
47+
48+
### 🛠️ USAGE
49+
```typescript
50+
// Seamlessly integrate src into your refined workflows:
51+
import { /* exported members */ } from '@path/to/src';
52+
```

backend/src/common/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common)
2+
3+
## 🏷️ 📁 Common
4+
5+
### 🎯 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.
7+
8+
### 🏗️ ARCHITECTURE
9+
```mermaid
10+
graph TD
11+
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]
18+
```
19+
20+
### 📄 FILE REGISTRY
21+
| File Name | Type | Responsibility | Key Aliases Used |
22+
|---|---|---|---|
23+
| *No exclusive files* | - | Architecturally reserved | - |
24+
25+
26+
### 🔗 DEPENDENCIES
27+
- *Self-contained premium module.*
28+
29+
### 🛠️ USAGE
30+
```typescript
31+
// Seamlessly integrate common into your refined workflows:
32+
import { /* exported members */ } from '@path/to/common';
33+
```
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [config](/backend/src/common/config)
2+
3+
## 🏷️ 🛠️ Config
4+
5+
### 🎯 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.
7+
8+
### 🏗️ ARCHITECTURE
9+
```mermaid
10+
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)
16+
```
17+
18+
### 📄 FILE REGISTRY
19+
| File Name | Type | Responsibility | Key Aliases Used |
20+
|---|---|---|---|
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+
26+
27+
### 🔗 DEPENDENCIES
28+
- `@nestjs/common`
29+
- `@nestjs/config`
30+
31+
### 🛠️ USAGE
32+
```typescript
33+
// Seamlessly integrate config into your refined workflows:
34+
import { /* exported members */ } from '@path/to/config';
35+
```
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [database](/backend/src/common/database)
2+
3+
## 🏷️ 💾 Database
4+
5+
### 🎯 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.
7+
8+
### 🏗️ ARCHITECTURE
9+
```mermaid
10+
graph TD
11+
database[💾 database]
12+
database --> database_module_ts(database.module.ts)
13+
```
14+
15+
### 📄 FILE REGISTRY
16+
| File Name | Type | Responsibility | Key Aliases Used |
17+
|---|---|---|---|
18+
| `database.module.ts` | `ts` | Encapsulates premium logic and definitions for `database.module.ts`. | @nestjs/config, @nestjs/common, @nestjs/mongoose |
19+
20+
21+
### 🔗 DEPENDENCIES
22+
- `@nestjs/common`
23+
- `@nestjs/config`
24+
- `@nestjs/mongoose`
25+
26+
### 🛠️ USAGE
27+
```typescript
28+
// Seamlessly integrate database into your refined workflows:
29+
import { /* exported members */ } from '@path/to/database';
30+
```
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# [backend](/backend) / [src](/backend/src) / [common](/backend/src/common) / [decorators](/backend/src/common/decorators)
2+
3+
## 🏷️ ✨ Decorators
4+
5+
### 🎯 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.
7+
8+
### 🏗️ ARCHITECTURE
9+
```mermaid
10+
graph TD
11+
decorators[✨ decorators]
12+
decorators --> public_decorator_ts(public.decorator.ts)
13+
decorators --> roles_decorator_ts(roles.decorator.ts)
14+
```
15+
16+
### 📄 FILE REGISTRY
17+
| File Name | Type | Responsibility | Key Aliases Used |
18+
|---|---|---|---|
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+
22+
23+
### 🔗 DEPENDENCIES
24+
- `@nestjs/common`
25+
26+
### 🛠️ USAGE
27+
```typescript
28+
// Seamlessly integrate decorators into your refined workflows:
29+
import { /* exported members */ } from '@path/to/decorators';
30+
```

0 commit comments

Comments
 (0)