Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
# βš™οΈ Backend Directory

[backend](/backend)

## 🎯 Purpose
A high-level module handling `backend` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
backend[backend] --> Files
backend --> test[test]
backend --> src[src]
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `eslint.config.mjs` | File | Provides localized file definitions. | @eslint/js |
| `nest-cli.json` | File | Provides localized file definitions. | None |
| `package-lock.json` | File | Provides localized file definitions. | None |
| `package.json` | File | Provides localized file definitions. | None |
| `tsconfig.build.json` | File | Provides localized file definitions. | None |
| `tsconfig.json` | File | Provides localized file definitions. | None |

## πŸ”— Dependencies
- `@eslint/js`

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ backend

[Root](/.) > [backend](/backend)
Expand Down
51 changes: 51 additions & 0 deletions backend/src/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
# πŸ’» Src Directory

[backend](/backend) > [src](/backend/src)

## 🎯 Purpose
A high-level module handling `src` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
src[src] --> Files
src --> common[common]
src --> modules[modules]
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `app.controller.spec.ts` | Test | Handles incoming HTTP requests and routing. | @nestjs/testing |
| `app.controller.ts` | Controller | Handles incoming HTTP requests and routing. | @nestjs/common |
| `app.module.ts` | Module | Provides localized module definitions. | @modules/veil, @modules/payment, @modules/partnership, @modules/gallery, @nestjs/serve-static, @modules/user, @modules/treatments, @modules/auth, @modules/booking, @modules/admin-settings, @nestjs/common, @modules/inventory |
| `app.service.ts` | Service | Executes core business logic and use cases. | @nestjs/common |
| `main.ts` | TypeScript | Provides localized typescript definitions. | @nestjs/common, @nestjs/core, @nestjs/config |

## πŸ”— 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
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ src

[Root](/.) > [backend](/backend) > [src](/backend/src)
Expand Down
38 changes: 38 additions & 0 deletions backend/src/common/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
# 🀝 Common Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common)

## 🎯 Purpose
A high-level module handling `common` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
common[common] --> Files
common --> database[database]
common --> config[config]
common --> utils[utils]
common --> filters[filters]
common --> interfaces[interfaces]
common --> guards[guards]
common --> decorators[decorators]
common --> constants[constants]
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|

## πŸ”— Dependencies
- No major internal/external path aliases detected.

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ common

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common)
Expand Down
35 changes: 35 additions & 0 deletions backend/src/common/config/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# βš™οΈ Config Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [config](/backend/src/common/config)

## 🎯 Purpose
A high-level module handling `config` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
config[config] --> Files
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `app-config.module.ts` | Module | Provides localized module definitions. | @nestjs/common, @nestjs/config |
| `app-config.service.ts` | Service | Executes core business logic and use cases. | @nestjs/common, @nestjs/config |
| `configuration.ts` | TypeScript | Provides localized typescript definitions. | None |
| `env.validation.ts` | TypeScript | Provides localized typescript definitions. | None |

## πŸ”— Dependencies
- `@nestjs/common`
- `@nestjs/config`

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ config

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [config](/backend/src/common/config)
Expand Down
31 changes: 31 additions & 0 deletions backend/src/common/constants/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# πŸ”’ Constants Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [constants](/backend/src/common/constants)

## 🎯 Purpose
A high-level module handling `constants` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
constants[constants] --> Files
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `error-messages.constant.ts` | TypeScript | Provides localized typescript definitions. | None |

## πŸ”— Dependencies
- No major internal/external path aliases detected.

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ constants

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [constants](/backend/src/common/constants)
Expand Down
33 changes: 33 additions & 0 deletions backend/src/common/database/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
# πŸ’Ύ Database Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [database](/backend/src/common/database)

## 🎯 Purpose
A high-level module handling `database` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
database[database] --> Files
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `database.module.ts` | Module | Provides localized module definitions. | @nestjs/common, @nestjs/config, @nestjs/mongoose |

## πŸ”— Dependencies
- `@nestjs/common`
- `@nestjs/config`
- `@nestjs/mongoose`

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ database

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [database](/backend/src/common/database)
Expand Down
32 changes: 32 additions & 0 deletions backend/src/common/decorators/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# ✨ Decorators Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [decorators](/backend/src/common/decorators)

## 🎯 Purpose
A high-level module handling `decorators` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
decorators[decorators] --> Files
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `public.decorator.ts` | TypeScript | Provides localized typescript definitions. | @nestjs/common |
| `roles.decorator.ts` | TypeScript | Provides localized typescript definitions. | @nestjs/common |

## πŸ”— Dependencies
- `@nestjs/common`

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ decorators

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [decorators](/backend/src/common/decorators)
Expand Down
31 changes: 31 additions & 0 deletions backend/src/common/filters/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# 🧹 Filters Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [filters](/backend/src/common/filters)

## 🎯 Purpose
A high-level module handling `filters` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
filters[filters] --> Files
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `i18n-exception.filter.ts` | TypeScript | Provides localized typescript definitions. | @nestjs/common |

## πŸ”— Dependencies
- `@nestjs/common`

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ filters

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [filters](/backend/src/common/filters)
Expand Down
34 changes: 34 additions & 0 deletions backend/src/common/guards/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,37 @@
# πŸ›‘οΈ Guards Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [guards](/backend/src/common/guards)

## 🎯 Purpose
A high-level module handling `guards` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
guards[guards] --> Files
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `jwt-auth.guard.ts` | TypeScript | Handles authentication/authorization protection. | @nestjs/common, @nestjs/core, @nestjs/passport |
| `roles.guard.ts` | TypeScript | Handles authentication/authorization protection. | @nestjs/common, @nestjs/core |

## πŸ”— Dependencies
- `@nestjs/common`
- `@nestjs/core`
- `@nestjs/passport`

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ guards

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [guards](/backend/src/common/guards)
Expand Down
31 changes: 31 additions & 0 deletions backend/src/common/interfaces/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# πŸ“‹ Interfaces Directory

[backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [interfaces](/backend/src/common/interfaces)

## 🎯 Purpose
A high-level module handling `interfaces` logic within the Mavluda Beauty ecosystem. This directory adheres to our "Luxury Professional" architectural standards.


## πŸ—οΈ Architecture
```mermaid
graph TD
interfaces[interfaces] --> Files
```


## πŸ“„ File Registry
| File Name | Type | Responsibility | Key Aliases Used |
|-----------|------|----------------|------------------|
| `authenticated-request.interface.ts` | Interface | Provides localized interface definitions. | None |

## πŸ”— Dependencies
- No major internal/external path aliases detected.

## πŸ› οΈ Usage
```typescript
// Architectural overview snippet
import { InternalLogic } from './internal-file';
// Ensure adherence to Hexagonal / FSD principles
```

## πŸ“ Existing Context
# πŸ“ interfaces

[Root](/.) > [backend](/backend) > [src](/backend/src) > [common](/backend/src/common) > [interfaces](/backend/src/common/interfaces)
Expand Down
Loading