-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9e74a33
commit 4040e49
Showing
2 changed files
with
124 additions
and
58 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,139 @@ | ||
| <p align="center"> | ||
| <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" 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://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></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"/></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"></a> | ||
| </p> | ||
| <!--[](https://opencollective.com/nest#backer) | ||
| [](https://opencollective.com/nest#sponsor)--> | ||
|
|
||
| ## Description | ||
|
|
||
| [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. | ||
|
|
||
| ## Installation | ||
| # Check-out-backend | ||
|
|
||
| ```bash | ||
| $ npm install | ||
| ``` | ||
| ## Backend Tech stack | ||
|
|
||
| ## Running the app | ||
| 1. **NestJS** | ||
| 2. **Prisma** | ||
| 3. **PostgreSQL** | ||
|
|
||
| ```bash | ||
| # development | ||
| $ npm run start | ||
| ### Directory Description (src dir) | ||
|
|
||
| # watch mode | ||
| $ npm run start:dev | ||
| 📂 ai | ||
|
|
||
| # production mode | ||
| $ npm run start:prod | ||
| ``` | ||
| - API for LookBook | ||
|
|
||
| ## Test | ||
| 📂 auth | ||
|
|
||
| ```bash | ||
| # unit tests | ||
| $ npm run test | ||
| - API for sign-up and sign-in (JWT) | ||
|
|
||
| # e2e tests | ||
| $ npm run test:e2e | ||
| 📂 file | ||
|
|
||
| # test coverage | ||
| $ npm run test:cov | ||
| ``` | ||
| - API for file upload using minIO | ||
|
|
||
| 📂 post | ||
|
|
||
| - API for posts (CRUD) | ||
|
|
||
| ## Support | ||
| 📂 prisma | ||
|
|
||
| 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). | ||
| - to use prisma | ||
|
|
||
| 📂 user | ||
|
|
||
| - API for user info (etc..) | ||
|
|
||
| ### Directory Tree | ||
|
|
||
| ```bash | ||
| ┣ 📂 .github/workflows | ||
| ┃ ┗ 📜 staging.yaml // confing github action | ||
| ┣ 📂 ERD | ||
| ┃ ┗ 📜 database.dbml // Database structure | ||
| ┃ ┣ 📂 prisma | ||
| ┃ ┣ 📂 migrations // migration files | ||
| ┃ ┃ ┣ 📜 20240521051320_init | ||
| ┃ ┃ ┣ 📜 20240530154723_fix_content_column | ||
| ┃ ┃ ┣ 📜 ... | ||
| ┃ ┃ ┗ 📜 migration_lock.toml | ||
| ┃ ┗ 📜 schema.prisma // prisma schema file | ||
| ┣ 📂 src | ||
| ┃ ┣ 📂 ai // api about generating lookbook | ||
| ┃ ┃ ┣ 📂 dto | ||
| ┃ ┃ ┃ ┣ 📂 req | ||
| ┃ ┃ ┃ ┃ ┗ 📜 AiReqBody.dto.ts | ||
| ┃ ┃ ┃ ┗ 📂 res | ||
| ┃ ┃ ┃ ┃ ┣ 📜 CreateLookBook.dto.ts | ||
| ┃ ┃ ┃ ┃ ┣ 📜 DeleteLookBook.dto.ts | ||
| ┃ ┃ ┃ ┃ ┣ 📜 GetLookBookById.dto.ts | ||
| ┃ ┃ ┃ ┃ ┗ 📜 GetLookBookByUserUuid.dto.ts | ||
| ┃ ┃ ┣ 📜 ai.controller.ts | ||
| ┃ ┃ ┣ 📜 ai.module.ts | ||
| ┃ ┃ ┣ 📜 ai.repository.ts | ||
| ┃ ┃ ┗ 📜 ai.service.ts | ||
| ┃ ┣ 📂 auth // api about sign-up and sign-in | ||
| ┃ ┃ ┣ 📂 dto | ||
| ┃ ┃ ┃ ┣ 📂 req | ||
| ┃ ┃ ┃ ┃ ┣ 📜 Login.dto.ts | ||
| ┃ ┃ ┃ ┃ ┣ 📜 RefreshToken.dto.ts | ||
| ┃ ┃ ┃ ┃ ┗ 📜 Register.dto.ts | ||
| ┃ ┃ ┃ ┗ 📂 res | ||
| ┃ ┃ ┃ ┃ ┣ 📜 LoginRes.dto.ts | ||
| ┃ ┃ ┃ ┃ ┣ 📜 RefreshTokenRes.dto.ts | ||
| ┃ ┃ ┃ ┃ ┗ 📜 RegisterRes.dto.ts | ||
| ┃ ┃ ┣ 📂 guard | ||
| ┃ ┃ ┃ ┣ 📜 jwt-auth.guard.ts | ||
| ┃ ┃ ┃ ┗ 📜 jwt.strategy.ts | ||
| ┃ ┃ ┣ 📜 auth.controller.ts | ||
| ┃ ┃ ┣ 📜 auth.module.ts | ||
| ┃ ┃ ┣ 📜 auth.repository.ts | ||
| ┃ ┃ ┗ 📜 auth.service.ts | ||
| ┃ ┣ 📂 file // api about upload image file | ||
| ┃ ┃ ┣ 📜 file.module.ts | ||
| ┃ ┃ ┗ 📜 file.service.ts | ||
| ┃ ┣ 📂 post // api about posts | ||
| ┃ ┃ ┣ 📂 dto | ||
| ┃ ┃ ┃ ┣ 📂 req | ||
| ┃ ┃ ┃ ┃ ┣ 📜 CreatePost.dto.ts | ||
| ┃ ┃ ┃ ┃ ┣ 📜 GetPostListQuery.dto.ts | ||
| ┃ ┃ ┃ ┃ ┗ 📜 UpdatePost.dto.ts | ||
| ┃ ┃ ┃ ┗ 📂 res | ||
| ┃ ┃ ┃ ┃ ┣ 📜 deletePostRes.dto.ts | ||
| ┃ ┃ ┃ ┃ ┗ 📜 postRes.dto.ts | ||
| ┃ ┃ ┣ 📂 types | ||
| ┃ ┃ ┃ ┗ 📜 PostFullContent.ts | ||
| ┃ ┃ ┣ 📜 post.controller.ts | ||
| ┃ ┃ ┣ 📜 post.mapper.ts | ||
| ┃ ┃ ┣ 📜 post.module.ts | ||
| ┃ ┃ ┣ 📜 post.repository.ts | ||
| ┃ ┃ ┗ 📜 post.service.ts | ||
| ┃ ┣ 📂 prisma // to use prisma service | ||
| ┃ ┃ ┣ 📜 prisma.module.ts | ||
| ┃ ┃ ┗ 📜 prisma.service.ts | ||
| ┃ ┣ 📂 user // api about user | ||
| ┃ ┃ ┣ 📂 decorator | ||
| ┃ ┃ ┃ ┗ 📜 get-user.decorator.ts | ||
| ┃ ┃ ┣ 📂 dto | ||
| ┃ ┃ ┃ ┣ 📂 req | ||
| ┃ ┃ ┃ ┃ ┗ 📜 UpdateUserInfo.dto.ts | ||
| ┃ ┃ ┃ ┗ 📂 res | ||
| ┃ ┃ ┃ ┃ ┗ 📜 GetUserInfo.dto.ts | ||
| ┃ ┃ ┣ 📜 user.controller.ts | ||
| ┃ ┃ ┣ 📜 user.module.ts | ||
| ┃ ┃ ┣ 📜 user.repository.ts | ||
| ┃ ┃ ┗ 📜 user.service.ts | ||
| ┃ ┣ 📜 app.controller.spec.ts | ||
| ┃ ┣ 📜 app.controller.ts | ||
| ┃ ┣ 📜 app.module.ts | ||
| ┃ ┣ 📜 app.service.ts | ||
| ┃ ┗ 📜 main.ts | ||
| ┣ 📂 test | ||
| ┣ 📜 .eslintrc.js | ||
| ┣ 📜 .gitignore | ||
| ┣ 📜 .prettierrc | ||
| ┣ 📜 Dockerfile | ||
| ┣ 📜 README.md | ||
| ┣ 📜 nest-cli.json | ||
| ┣ 📜 package-lock.json | ||
| ┣ 📜 package.json | ||
| ┣ 📜 tsconfig.build.json | ||
| ┗ 📜 tsconfig.json | ||
|
|
||
| ``` | ||
|
|
||
| ## Stay in touch | ||
| ## Database | ||
|
|
||
| - Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) | ||
| - Website - [https://nestjs.com](https://nestjs.com/) | ||
| - Twitter - [@nestframework](https://twitter.com/nestframework) | ||
| You can see dbdocs in [here](https://dbdocs.io/GanghyeonSeo/check-out-backend?view=relationships). | ||
|
|
||
| ## License | ||
| ### Database Relation Diagram | ||
|
|
||
| Nest is [MIT licensed](LICENSE). | ||
|  |