Skip to content
@2024-4lineton

2024-4lineton

HelFooMe

ํ”„๋กœ์ ํŠธ ๋กœ๊ณ 

๐Ÿฅ” HelFooMe

์Œ์‹์„ ๋ณด๋‹ค ๊ฐ€์น˜์žˆ๊ฒŒ ์ง€์†๊ฐ€๋Šฅํ•œ ์†Œ๋น„๋ฅผ ์ด‰์ง„ํ•˜๋Š” ํ‘ธ๋“œ ๋ผ์ดํ”„์Šคํƒ€์ผ ํ”Œ๋žซํผ
์†Œ์ƒ๊ณต์ธ ์ƒ์ƒ ํ‘ธ๋“œ ํ…Œํฌ
ํ™˜๊ฒฝ๊ณผ ์Œ์‹์„ ์ƒ๊ฐํ•˜๋Š” ์ œ๋กœ์›จ์ด์ŠคํŠธ ์„œ๋น„์Šค

๐ŸŽฏ ํ”„๋กœ์ ํŠธ์˜ ๋ชฉ์ (Purpose)

๋ฉ‹์Ÿ์ด์ž์‚ฌ์ฒ˜๋Ÿผ 12๊ธฐ 4ํ˜ธ์„ ํ†ค
"์Œ์‹ ๋‚ญ๋น„ ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๊ณ , ์ง€์† ๊ฐ€๋Šฅํ•œ ์†Œ๋น„์™€ ํ™˜๊ฒฝ ๋ณดํ˜ธ๋ฅผ ์ด‰์ง„ํ•˜๊ธฐ ์œ„ํ•œ ์„œ๋น„์Šค ์ œ์ž‘"
ํ˜„๋Œ€ ์‚ฌํšŒ์—์„œ ์‹๋Ÿ‰ ์ž์›์€ ํ’์š”๋กœ์šฐ๋ฉด์„œ๋„ ๋งŽ์€ ์–‘์ด ๋ถˆํ•„์š”ํ•˜๊ฒŒ ํ๊ธฐ๋˜๊ณ  ์žˆ์œผ๋ฉฐ, ์ด๋กœ ์ธํ•ด ๋ฐœ์ƒํ•˜๋Š” ํ™˜๊ฒฝ์ , ๊ฒฝ์ œ์  ์†์‹ค์— ๋Œ€ํ•œ ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜์ž๋Š” ์˜๊ฒฌ์œผ๋กœ๋ถ€ํ„ฐ ์ฃผ์ œ ์‹คํ˜„

ํ”„๋กœ์ ํŠธ ๊ธฐ๊ฐ„ : 2024/10/08 ~ 2024/11/16

๐Ÿคฉ ํŒ€์›๋“ค(Team Members)

Lead(FE Developer) PM Design BE Developer BE Developer FE Developer
์ด์„ธ์€ ๊ตฌ๋„์šฑ ๊น€๋ณต๋ฏผ ์œคํฌ์ค€ ์กฐ์ˆ˜๋นˆ ์กฐ์ˆ˜๋นˆ

๐Ÿ› ๏ธ ๊ธฐ์ˆ  ์Šคํƒ(Tech)

FE

React Bootstrap Recoil

BE

Spring Boot MySQL JWT

Infra

Amazon AWS Linux Ubuntu Docker Nginx GitHub Actions

ํ˜‘์—… ํˆด (Tools)

GitHub Notion Swagger

๋””์ž์ธ

Figma Adobe Illustrator

ERD ์„ค๊ณ„

erd

API ์„ค๊ณ„ ๋ฌธ์„œ

์ž‘์„ฑ์ค‘

GitHub Flow

github-flow

๐ŸŽฏ Branch Convention & Git Convention

๐ŸŽฏ Git Convention

  • ๐ŸŽ‰ Start: Start New Project [:tada]
  • โœจ Feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ [:sparkles]
  • ๐Ÿ› Fix: ๋ฒ„๊ทธ ์ˆ˜์ • [:bug]
  • ๐ŸŽจ Design: CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ [:art]
  • โ™ป๏ธ Refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง [:recycle]
  • ๐Ÿ”ง Settings: Changing configuration files [:wrench]
  • ๐Ÿ—ƒ๏ธ Comment: ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ [:card_file_box]
  • โž• Dependency/Plugin: Add a dependency/plugin [:heavy_plus_sign]
  • ๐Ÿ“ Docs: ๋ฌธ์„œ ์ˆ˜์ • [:memo]
  • ๐Ÿ”€ Merge: Merge branches [:twisted_rightwards_arrows:]
  • ๐Ÿš€ Deploy: Deploying stuff [:rocket]
  • ๐Ÿšš Rename: ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ [:truck]
  • ๐Ÿ”ฅ Remove: ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ [:fire]
  • โช๏ธ Revert: ์ „ ๋ฒ„์ „์œผ๋กœ ๋กค๋ฐฑ [:rewind]

๐Ÿชด Branch Convention (GitHub Flow)

  • main: ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ๋ธŒ๋žœ์น˜, ํ•ญ์ƒ ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ๋ฅผ ์œ ์ง€
  • feature/{description}: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ๊ฐœ๋ฐœํ•˜๋Š” ๋ธŒ๋žœ์น˜
    • ์˜ˆ: feature/social-login

Flow

  1. main ๋ธŒ๋žœ์น˜์—์„œ ์ƒˆ๋กœ์šด ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑ.
  2. ์ž‘์—…์„ ์™„๋ฃŒํ•˜๊ณ  ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€์— ๋งž๊ฒŒ ์ปค๋ฐ‹.
  3. Pull Request๋ฅผ ์ƒ์„ฑ / ํŒ€์›๋“ค์˜ ๋ฆฌ๋ทฐ.
  4. ๋ฆฌ๋ทฐ๊ฐ€ ์™„๋ฃŒ๋˜๋ฉด main ๋ธŒ๋žœ์น˜๋กœ ๋ณ‘ํ•ฉ.
  5. ๋ณ‘ํ•ฉ ํ›„, ํ•„์š”์‹œ ๋ฐฐํฌ.

์˜ˆ์‹œ:

# ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
git checkout -b feature/social-login

# ์ž‘์—… ์™„๋ฃŒ ํ›„, main ๋ธŒ๋žœ์น˜๋กœ ๋ณ‘ํ•ฉ
git checkout main
git pull origin main
git merge feature/social-login
git push origin main

๐Ÿ‹ ๋กœ์ปฌ์—์„œ Docker ๋กœ ๋นŒ๋“œํ•˜๊ธฐ ๐Ÿ‹

  1. Docker Desktop ์‹คํ–‰
  2. Build ํ•˜๊ธฐ ์ „ spotless ์ ์šฉ ./gradlew spotlessApply
  3. ์ •ํ•ด์ง„ ์ปจ๋ฒค์…˜์„ ์ง€ํ‚ค๊ณ  ์žˆ๋Š”์ง€ ๊ฒ€์‚ฌ (spotelesscheck) ./gradlew spotlessCheck
  4. spring boot build ./gradlew build
  5. Docker Desktop ์‹คํ–‰์ค‘ ์ธ์ง€ ํ™•์ธ docker info
  6. Docker๋กœ ๋นŒ๋“œํ•˜๊ธฐ docker build -t "๋ณธ์ธ dockerhub repo ์ด๋ฆ„"/helfoome .
  7. Docker Hub login(IDE terminal์—์„œ ์‹คํ–‰) docker login
  8. Docker Image Tag docker tag "๋ณธ์ธ dockerhub repo ์ด๋ฆ„"/helfoome "๋ณธ์ธ dockerhub repo ์ด๋ฆ„"/helfoome:latest
  9. Docker Image Push docker push "๋ณธ์ธ dockerhub repo ์ด๋ฆ„"/helfoome:latest

๐Ÿ‹ Docker ์‹คํ–‰์ค‘์ธ ์ปจํ…Œ์ด๋„ˆ ์ค‘์ง€ํ•˜๊ธฐ ๐Ÿ‹

  1. ์‹คํ–‰ ์ค‘์ธ ์ปจํ…Œ์ด๋„ˆ ๋ชฉ๋ก ํ™•์ธ docker ps
  2. ์ปจํ…Œ์ด๋„ˆ ์ค‘์ง€ ์‹คํ–‰ ์ค‘์ธ ์ปจํ…Œ์ด๋„ˆ์˜ CONTAINER ID๋ฅผ ์ฐพ์•„์„œ ์ค‘์ง€. docker stop <CONTAINER ID>
  3. ์ปจํ…Œ์ด๋„ˆ์˜ ์‚ญ์ œ๊ฐ€ ํ•„์š”ํ•  ๊ฒฝ์šฐ docker rm <CONTAINER ID>
  4. ์ด๋ฏธ์ง€ ์‚ญ์ œ๊ฐ€ ํ•„์š”ํ•  ๊ฒฝ์šฐ docker rmi <IMAGE ID or IMAGE NAME>

Popular repositories Loading

  1. FrontEnd FrontEnd Public

    FE Code Space

    JavaScript 1

  2. BackEnd BackEnd Public

    BE Code Space

    Java 2

  3. .github .github Public

    Main README.md

Repositories

Showing 3 of 3 repositories

Top languages

Loadingโ€ฆ

Most used topics

Loadingโ€ฆ