|
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 | | - <!--[](https://opencollective.com/nest#backer) |
22 | | - [](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) |
32 | 21 | ``` |
33 | 22 |
|
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'; |
45 | 42 | ``` |
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). |
0 commit comments