Skip to content

๐Ÿฌ ๐Ÿฌ NestJS + TypeORM ์‡ผํ•‘๋ชฐ ์„œ๋ฒ„

License

Notifications You must be signed in to change notification settings

Lim-Changi/AconShop

Repository files navigation

Acon Shop

Short Description

ํŒ๋งค์ž๋Š” ์ƒํ’ˆ์„ ์˜ฌ๋ฆด ์ˆ˜ ์žˆ๊ณ , ๊ด€๋ฆฌ์ž๋Š” ์ƒํ’ˆ์„ ์Šน์ธ ๋ฐ ๊ด€๋ฆฌํ•˜๋ฉฐ, ๊ตฌ๋งค์ž๋Š” ์Šน์ธ๋œ ์ƒํ’ˆ์„ ๊ตฌ๋งคํ•  ์ˆ˜ ์žˆ๋Š” ๊ฐ„๋‹จํ•œ ์‡ผํ•‘๋ชฐ ์„œ๋ฒ„.

Stack

Framework

  • NestJS - Typescript

DB

  • MySQL

ORM

  • TypeORM

Testing Tool

  • Jest

Deploy

  • AWS Beanstalk / Docker

API Docs

  • Swagger UI

DB Table ERD

แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2022-06-02 แ„‹แ…ฉแ„’แ…ฎ 3 56 30

CI/CD Workflow

แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2022-06-02 แ„‹แ…ฉแ„’แ…ฎ 3 54 16

Swagger Api Test Flow

Swagger Docs [Link]

ID: acon PW: 1234

  1. ํšŒ์›๊ฐ€์ž… API ๋ฅผ ํ†ตํ•ด ์œ ์ € ์ƒ์„ฑ -> ์—ฌ๊ธฐ์„œ ์ž…๋ ฅํ•˜๋Š” Role ์— ๋”ฐ๋ผ ์ ‘๊ทผ๊ฐ€๋Šฅํ•œ API ๊ฐ€ ๊ฒฐ์ •๋จ
  2. ๋กœ๊ทธ์ธ API ์— ๊ณ„์ • ID, Password ์ž…๋ ฅ -> AccessToken ๋ฐœ๊ธ‰
  3. ๋ฐœ๊ธ‰๋œ AccessToken ์„ ์šฐ์ธก ์ƒ๋‹จ Authorize ๋ฒ„ํŠผ์„ ํด๋ฆญํ•˜์—ฌ Bearer Token ์— ์ž…๋ ฅ
  4. ๊ด€๋ฆฌ์ž Case
    • ๋‚˜๋ผ ์ถ”๊ฐ€ API ๋ฅผ ํ†ตํ•ด ๋‚˜๋ผ ์ถ”๊ฐ€
    • ์ „์ฒด ๋‚˜๋ผ ์กฐํšŒ API ๋ฅผ ํ†ตํ•ด ์ „์ฒด ๊ตญ๊ฐ€ ๋ชฉ๋ก์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Œ
    • ๊ฒ€ํ†  ๋Œ€๊ธฐ ์ƒํ’ˆ ์กฐํšŒ API ๋ฅผ ํ†ตํ•ด ์ž‘๊ฐ€๊ฐ€ ์ œ์ถœํ•œ ๊ฒ€ํ†  ๋Œ€๊ธฐ์ค‘์ธ ์ƒํ’ˆ์„ ์กฐํšŒํ•  ์ˆ˜ ์žˆ์Œ
    • ์ƒํ’ˆ ๊ฒ€ํ†  ๋ฐ ์ˆ˜์ • API ๋ฅผ ํ†ตํ•ด ์ƒํ’ˆ์˜ ์ •๋ณด๋ฅผ ์ˆ˜์ •ํ•  ์ˆ˜ ์žˆ์Œ
    • ํƒ€ ๊ตญ๊ฐ€ ์ƒํ’ˆ ์ถ”๊ฐ€ API ๋ฅผ ํ†ตํ•ด ํ•œ๊ตญ ์ƒํ’ˆ์˜ ์ •๋ณด๋ฅผ ์—ฌ๋Ÿฌ ๊ตญ๊ฐ€์˜ ์ƒํ’ˆ์œผ๋กœ ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ์Œ
  5. ํŒ๋งค์ž(์ž‘๊ฐ€) Case
    • ์ƒํ’ˆ ์ œ์ถœ API ๋ฅผ ํ†ตํ•ด ์ž‘ํ’ˆ์„ ์ œ์ถœํ•  ์ˆ˜ ์žˆ์Œ
  6. ๊ตฌ๋งค์ž Case
    • ์ƒํ’ˆ ๊ตฌ๋งค API ๋ฅผ ํ†ตํ•ด ๊ฒ€ํ† ๊ฐ€ ์™„๋ฃŒ๋œ ์ƒํ’ˆ์„ ๊ตฌ๋งคํ•  ์ˆ˜ ์žˆ์Œ
  7. ๋ชจ๋“  ์œ ์ €
    • ๋‚˜๋ผ๋ณ„ ์ƒํ’ˆ ์กฐํšŒ API ๋ฅผ ํ†ตํ•ด ๊ฒ€ํ† ๊ฐ€ ์™„๋ฃŒ๋œ ์ž‘ํ’ˆ ๋ชฉ๋ก์„ ๊ตญ๊ฐ€๋ณ„๋กœ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Œ

< ์ž์„ธํ•œ API Response ์ •๋ณด๋Š” Example ์˜† Schema ๋ฅผ ํ†ตํ•ด ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. >

About

๐Ÿฌ ๐Ÿฌ NestJS + TypeORM ์‡ผํ•‘๋ชฐ ์„œ๋ฒ„

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published