Skip to content
Merged
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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,7 @@ dist-ssr
*.njsproj
*.sln
*.sw?
*.md
!README.md
!GEMINI.md
!AGENTS.md
4 changes: 4 additions & 0 deletions .gitignore_append
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.md
!README.md
!GEMINI.md
!AGENTS.md
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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';
```
134 changes: 39 additions & 95 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,42 @@
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</p>

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

<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>
<p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<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>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
<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>
<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>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->

## 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).
52 changes: 52 additions & 0 deletions backend/src/README.md
Original file line number Diff line number Diff line change
@@ -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';
```
33 changes: 33 additions & 0 deletions backend/src/common/README.md
Original file line number Diff line number Diff line change
@@ -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';
```
35 changes: 35 additions & 0 deletions backend/src/common/config/README.md
Original file line number Diff line number Diff line change
@@ -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';
```
30 changes: 30 additions & 0 deletions backend/src/common/database/README.md
Original file line number Diff line number Diff line change
@@ -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';
```
30 changes: 30 additions & 0 deletions backend/src/common/decorators/README.md
Original file line number Diff line number Diff line change
@@ -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';
```
Loading
Loading