๐Ÿฐ Team2-TiramisuCake-BE

๐Ÿš™ The new IONIQ 5 ์ด๋ฒคํŠธ ํŽ˜์ด์ง€ ๐Ÿš™


๐Ÿ”— ๋ฐฐํฌ URL

Service https://softeer.site

Admin https://d3qmq1ffhp5il9.cloudfront.net


๐Ÿš€ ํ”„๋กœ์ ํŠธ ์ธ์› ๋ฐ ๊ธฐ๊ฐ„

  • ๊ฐœ๋ฐœ ์ธ์›: FE 2๋ช… & BE 2๋ช…
  • ํ”„๋กœ์ ํŠธ ๊ธฐ๊ฐ„: 2024.07.29 ~ 2024.08.26

๐Ÿ‘ค ํŒ€์›

avatar avatar avatar avatar
๊น€์ง€๋ฏผ ๋ฐ•์ง€ํ˜„ ์†์ฐฌํ˜ ์ด์„๋ฏผ

๐Ÿ’ก ๊ธฐ๋Šฅ ์†Œ๊ฐœ

์„œ๋น„์Šค

1. ๋ฉ”์ธ ํŽ˜์ด์ง€

๋ฉ”์ธ ํŽ˜์ด์ง€๋Š” ํฌ๊ฒŒ ๋žœ๋”ฉ ์„น์…˜, ์ด๋ฒคํŠธ ์„น์…˜, ๊ทธ๋ฆฌ๊ณ  ์ž๋™์ฐจ ์†Œ๊ฐœ ์„น์…˜์œผ๋กœ ๊ตฌ์„ฑ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.
์‚ฌ์šฉ์ž๊ฐ€ ๋ถ€๋“œ๋Ÿฝ๊ฒŒ ์„น์…˜ ๊ฐ„ ์ด๋™ํ•  ์ˆ˜ ์žˆ๋„๋ก ์Šค๋ƒ… ๊ธฐ๋Šฅ์„ ์ ์šฉํ–ˆ์œผ๋ฉฐ, ํŽ˜์ด์ง€ ์ƒ๋‹จ์˜ ํ—ค๋”๋ฅผ ํ†ตํ•ด ์›ํ•˜๋Š” ์„น์…˜์œผ๋กœ ๋ฐ”๋กœ ์ด๋™ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
๋žœ๋”ฉ ์„น์…˜, ์ด๋ฒคํŠธ ์†Œ๊ฐœ ์„น์…˜, ์„ ์ฐฉ์ˆœ ์ด๋ฒคํŠธ ์†Œ๊ฐœ ์„น์…˜, ์ถ”์ฒจ ์ด๋ฒคํŠธ ์†Œ๊ฐœ ์„น์…˜, ๋งˆ์ง€๋ง‰์œผ๋กœ ์ฐจ๋Ÿ‰ ์ƒ์„ธ ์ •๋ณด ์„น์…˜์ด ์žˆ์Šต๋‹ˆ๋‹ค.
๊ฐ ์ด๋ฒคํŠธ ์„น์…˜์—์„œ ์ด๋ฒคํŠธ ๊ด€๋ จ ์ •๋ณด๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ๊ณ , ์ด๋ฒคํŠธ ์ฐธ์—ฌ์— ํ•„์š”ํ•œ ์•„์ด์˜ค๋‹‰ 5์˜ ์ฐจ๋Ÿ‰ ์ •๋ณด๋Š” ๋™์˜์ƒ๊ณผ ๊ฐ„๋‹จํ•œ ์†Œ๊ฐœ๊ฐ€ ์žˆ๋Š” ์ด๋ฏธ์ง€ ์บ๋Ÿฌ์…€์—์„œ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

2. ์„ ์ฐฉ์ˆœ ์ด๋ฒคํŠธ

์„ ์ฐฉ์ˆœ ํŽ˜์ด์ง€์—์„œ ์ œ์‹œ๋œ ๋ฌธ์ œ์˜ ๋นˆ์นธ์— ์ ์ ˆํ•œ ๋‹จ์–ด๋“ค์„ ๋“œ๋ž˜๊ทธํ•˜์—ฌ ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
๋ชจ๋“  ๋นˆ์นธ์„ ์˜ฌ๋ฐ”๋ฅด๊ฒŒ ์ฑ„์šฐ๋ฉด ์ž๋™์œผ๋กœ ์„ ์ฐฉ์ˆœ ์ด๋ฒคํŠธ์— ์‘๋ชจ๋˜๋ฉฐ, ์ง€์ •๋œ ์„ ์ฐฉ์ˆœ ์ธ์› ์•ˆ์— ๋“ค๋ฉด ๋” ๋‰ด ์•„์ด์˜ค๋‹‰ 5 24์‹œ๊ฐ„ ๋ ŒํŠธ ์ด์šฉ๊ถŒ๊ณผ ์‹ ์ฐจ ํ• ์ธ ์ฝ”๋“œ๋ฅผ ๋ฐ›์„ ์ˆ˜ ์žˆ๋Š” QR ์ฝ”๋“œ๋ฅผ ํš๋“ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

3. ์ถ”์ฒจ ์ด๋ฒคํŠธ

๋ณต๊ถŒ ์ด๋ฒคํŠธ์—์„œ๋Š” ์บ”๋ฒ„์Šค๋ฅผ ๊ธ์–ด ๊ฒฐ๊ณผ๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ๋งŒ์•ฝ ์„ธ ๊ฐœ์˜ ๋‹ค์ด์•„ ์ด๋ฏธ์ง€๊ฐ€ ๊ฐ™์€ ๋ฐฉํ–ฅ์œผ๋กœ ๋‚˜์˜ค๋ฉด ๋‹น์ฒจ๋œ ๊ฒƒ์ž…๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ์ƒ๋‹จ์—์„œ๋Š” ์‚ฌ์šฉ์ž ๊ณต์œ  URL์„ ํ†ตํ•ด ์ดˆ๋Œ€ํ•œ ์นœ๊ตฌ ์ˆ˜์™€ ๋‚จ์€ ๋ณต๊ถŒ ๊ธฐํšŒ๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ํ•˜๋‹จ์—์„œ๋Š” ์—ฐ์† ์ถœ์„ ์ผ์ˆ˜๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. 7์ผ ์—ฐ์† ์ถœ์„ํ•˜๋ฉด ์ƒํ’ˆ์„ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

4. ๊ธฐ๋Œ€ํ‰ ํŽ˜์ด์ง€

5๊ฐ€์ง€ ๊ธฐ๋Œ€ํ‰ ๋ฒ„ํŠผ์„ ํด๋ฆญํ•˜์—ฌ ํ•ด๋‹นํ•˜๋Š” ๊ธฐ๋Œ€ํ‰์„ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
๊ธฐ๋Œ€ํ‰์€ ์ปค์„œ ๊ธฐ๋ฐ˜ ๋ฌดํ•œ ์Šคํฌ๋กค ๋ฐฉ์‹์œผ๋กœ ๊ตฌํ˜„๋˜์–ด, ์‚ฌ์šฉ์ž๊ฐ€ ์Šคํฌ๋กค์„ ์˜ฌ๋ฆฌ๋ฉด ์ด์ „ ๊ธฐ๋Œ€ํ‰์„ ๊ณ„์†ํ•ด์„œ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.


์–ด๋“œ๋ฏผ

1. ๋ฉ”์ธ ํŽ˜์ด์ง€

2. ์ด๋ฒคํŠธ ๊ด€๋ฆฌ ํŽ˜์ด์ง€

์ด๋ฒคํŠธ ๊ด€๋ฆฌ ํŽ˜์ด์ง€์—์„œ ์ˆ˜์ •ํ•˜๊ธฐ ๋ฒ„ํŠผ์„ ํ†ตํ•ด ์„ ์ฐฉ์ˆœ ์ด๋ฒคํŠธ์™€ ์ถ”์ฒจ ์ด๋ฒคํŠธ์˜ ๋‚ ์งœ ๋ฐ ์‹œ๊ฐ„์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

3. ๋‹น์ฒจ ๊ด€๋ฆฌ ํŽ˜์ด์ง€

์ด๋ฒคํŠธ ๋‹น์ฒจ ๊ด€๋ฆฌ ํŽ˜์ด์ง€์—์„œ๋Š” ์„ ์ฐฉ์ˆœ ๋ฐ ์ถ”์ฒจ ๋‹น์ฒจ ์ธ์› ์ˆ˜๋ฅผ ์ˆ˜์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ, ๊ฐ ์ด๋ฒคํŠธ์˜ ๋‹น์ฒจ์ž ๋ชฉ๋ก์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

4. ์ด๋ฒคํŠธ ์ง€ํ‘œ ํŽ˜์ด์ง€

์ด๋ฒคํŠธ ๊ธฐ๊ฐ„ ๋™์•ˆ ๋‚ ์งœ๋ณ„ ๋ฉ”์ธ ํŽ˜์ด์ง€ ์ ‘์† ํšŸ์ˆ˜๋ฅผ ๋ง‰๋Œ€๊ทธ๋ž˜ํ”„๋กœ ํ™•์ธํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ์„ ์ฐฉ์ˆœ ๋ฐ ์ถ”์ฒจ ์ด๋ฒคํŠธ์˜ ์ฐธ์—ฌ์œจ์„ ์›๊ทธ๋ž˜ํ”„ ํ˜•ํƒœ๋กœ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

โš’๏ธ ๊ธฐ์ˆ  ์Šคํƒ

๊ฐœ๋ฐœํ™˜๊ฒฝ

  • ์–ธ์–ด : Java 17
  • ํ”„๋ ˆ์ž„์›Œํฌ : Spring Boot 3.3.2
  • ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค : MySQL 8.0JPARedis
  • ๋ฐฐํฌ: Github Action , S3, CodeDeploy
  • API ๋ฌธ์„œ : Swagger 3.0.0

์•„ํ‚คํ…์ฒ˜

์„œ๋ฒ„

image

๋ฐฐํฌ

image

๐Ÿ™Œ ํŒ€ ๊ทœ์น™

์ปค๋ฐ‹ & ๋ธŒ๋žœ์น˜

์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

// ์˜ˆ์‹œ

label: subject

- label์€ issue label๊ณผ ๋™์ผ
- subject์€ ํ•ด๋‹น ์ปค๋ฐ‹์— ๋Œ€ํ•œ ๋‚ด์šฉ์„ ์ž˜ ์ดํ•ดํ•  ์ˆ˜ ์žˆ๊ฒŒ ์š”์•ฝ ํ•  ๊ฒƒ

๋ธŒ๋žœ์น˜ ์ „๋žต

     main
       |
       |
     develop
       |
       |--------------------------|
       |                          |
feat/issue_num          feat/issue_num

- feat - ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„
- fix - ๋ณ€๊ฒฝ์‚ฌํ•ญ(๋ณ€์ˆ˜, css ๋“ฑ)
- refactor - ๊ตฌ์กฐ ๋ณ€๊ฒฝ ex) api ์ „ํ›„ ๋ฐ์ดํ„ฐ ๋ถˆ๋Ÿฌ์˜ค๊ธฐ ๋ณ€๊ฒฝ?
- Test - ํ…Œ์ŠคํŠธ ์ฝ”๋“œ

master ๋ธŒ๋žœ์น˜

  • ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ๋งŒ์„ ๊ด€๋ฆฌํ•˜๋Š” ๋ธŒ๋žœ์น˜

develop ๋ธŒ๋žœ์น˜

  • ๋‹ค์Œ์— ๋ฐฐํฌํ•  ๊ฒƒ์„ ๊ฐœ๋ฐœํ•˜๋Š” ๋ธŒ๋žœ์น˜
  • ๋ฐฐํฌ ํ›„, ๋ฌธ์ œ๊ฐ€ ์—†์œผ๋ฉด master ๋ธŒ๋žœ์น˜๋กœ PR

feature ๋ธŒ๋žœ์น˜

  • ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•  ๋•Œ ์‚ฌ์šฉํ•˜๋Š” ๋ธŒ๋žœ์น˜

๋ธŒ๋žœ์น˜ ์ „๋žต - [์•„๋ž˜ ์ฐธ๊ณ ]/issue number

  • feat - ์ƒˆ ๊ธฐ๋Šฅ
  • fix - ๋ณ€๊ฒฝ์‚ฌํ•ญ(๋ณ€์ˆ˜, css ๋“ฑ)
  • refactor - ๊ตฌ์กฐ ๋ณ€๊ฒฝ ex) api ์ „ํ›„ ๋ฐ์ดํ„ฐ ๋ถˆ๋Ÿฌ์˜ค๊ธฐ ๋ณ€๊ฒฝ?
  • test - ํ…Œ์ŠคํŠธ ์ฝ”๋“œ
  • chore - ํ™˜๊ฒฝ ์„ค์ •, ์ฃผ์„ ์ œ๊ฑฐ, ์ด๋ฏธ์ง€ ํŒŒ์ผ ์ถ”๊ฐ€ ๋“ฑ
๊ทธ๋ผ์šด๋“œ ๋ฃฐ

ํšŒ์˜

  • ๋งค์ผ ์•„์นจ์— 30๋ถ„ ์Šคํฌ๋Ÿผ
    • ๊ฐœ๋ฐœ ์ƒํ™ฉ, ์˜ค๋ฅ˜, ์˜ค๋Š˜ ํ•  ์ผ
  • ๋งค์ผ ์˜คํ›„ 6์‹œ์— ๊ฐ€๋Šฅํ•˜๋ฉด PR ํ•˜๊ธฐ
  • ํšŒ๊ณ  ์ž‘์„ฑ
    • ๋งค์ผ ์˜คํ›„ 6์‹œ 30๋ถ„
    • ์•Œ๊ฒŒ๋œ ์ , ์ข‹์•˜๋˜ ์ , ๋ณด์™„ํ•  ์ 

์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜

  • ๋งค์ผ ๊ฐ™์ด ๋ฐฅ๋จน๊ธฐ
    • ๋ฐฅ ๋จน์„ ๋•Œ ์ผ ์–˜๊ธฐ ํ•˜์ง€ ์•Š๊ธฐ
  • ํšŒ์˜ ์ค‘์— ์„œ๋กœ ํฐ์†Œ๋ฆฌ ๋‚ด์ง€ ์•Š๊ธฐ
  • ๋ฐ˜๋ฐ• ์˜๊ฒฌ ๋‚ด๊ธฐ ์ „์— ์ข‹์€ ์˜๊ฒฌ์ด๋ผ๊ณ  ๋จผ์ € ์นญ์ฐฌํ•˜๊ธฐ
  • ๋น„๋‚œํ•˜์ง€ ๋ง๊ธฐ
  • ๋งˆ์Œ์— ์•ˆ๋“œ๋Š”๊ฒŒ ์žˆ์–ด๋„ ์ข‹์€ ๋ง์„ ๋จผ์ €ํ•˜๊ณ  ๊ทธ ๋‹ค์Œ์— ๋งˆ์Œ์— ์•ˆ๋“œ๋Š” ๊ฒƒ์„ ๋งํ•˜๊ธฐ
  • ๋ฆฌ์•ก์…˜ ์ž˜ํ•ด์ฃผ๊ธฐ
  • ๋ฐ˜๋งํ•˜๊ธฐ
  • ์„œ๋กœ ์ธ์‚ฌ ์ž˜ ํ•˜๊ธฐ
  • ๋™์˜ํ•  ๋•Œ โ€œ๊ทธ๋ž˜โ€๊ฐ€ ์•„๋‹ˆ๋ผ โ€œ์ข‹์•„โ€๋ผ๊ณ  ๋งํ•˜๊ธฐ
  • ์ฃผ๋ง์— ๊ธ‰ํ•œ ์‚ฌํ•ญ์ด ์•„๋‹ˆ๋ฉด Discord๋กœ ์—ฐ๋ฝํ•˜์ง€ ๋ง๊ธฐ(์ตœ๋Œ€ํ•œ ํ‰์ผ์— ~^^)
  • ์ง€๊ฐ, ์กฐํ‡ด ์‹œ ๋ฏธ๋ฆฌ ์•Œ๋ ค์ฃผ๊ธฐ
ํšŒ๊ณ  https://www.notion.so/bside/3f4a3606067143fbb54bd5e584afe762