Skip to content

predictyson/Auctopus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

578 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๊ฒฝ๋งค์ค‘ (๊ฒฝ์ œ์ ์ด๊ณ  ๋งค๋ ฅ์ ์ธ ์ค‘๊ณ ๊ฑฐ๋ž˜ ํ”Œ๋žซํผ)

ํŒ๋งค์ž๋ฅผ ์œ„ํ•œ ํฅ์ •, ๊ตฌ๋งค์ž๋ฅผ ์œ„ํ•œ ๊ฑฐ๋ž˜

Table of Content

  1. ์„œ๋น„์Šค ๊ฐœ์š”
  2. ๊ธฐ์ˆ  ์Šคํƒ
  3. ํ•œ๋ˆˆ์— ๋ณด๋Š” ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜
  4. ํŒ€์› ์†Œ๊ฐœ
  5. Jira Convention
  6. Git Flow Convention
  7. Commit Message Convention
  8. Backend Convention
  9. Frontend Convention
  10. Wire Frames
  11. ๊ธฐ๋Šฅ ์ •์˜์„œ
  12. ERD
  13. Sequence Diagram
  14. References

1. ์„œ๋น„์Šค ๊ฐœ์š”

์ €ํฌ ์„œ๋น„์Šค๊ฐ€ ์ถ”๊ตฌํ•˜๋Š” ๋ชฉํ‘œ๋Š” ๊ฒฝ์ œ์ ์ด๊ณ  ๋งค๋ ฅ์ ์ธ ์ค‘๊ณ ๊ฑฐ๋ž˜ ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค.

  • ํ™”์ƒ ๊ธฐ์ˆ ์„ ํ†ตํ•ด ์›๊ฑฐ๋ฆฌ์—์„œ ์ค‘๊ณ  ์ƒํ’ˆ์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ํŒ๋งค์ž๋Š” ์ˆ˜์š”์— ๋งž๋Š” ๊ฐ€๊ฒฉ์„ ์ œ์‹œ๋ฐ›๊ณ , ๊ตฌ๋งค์ž๋Š” ๊ฐ€๊ฒฉ์— ๋งž๋Š” ์ƒํ’ˆ์„ ๊ตฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ์ค‘๊ณ ๊ฑฐ๋ž˜๋ฅผ ํ†ตํ•ด ์–ผ๋งŒํผ ํ™˜๊ฒฝ ๋ณดํ˜ธ์— ๊ธฐ์—ฌํ•˜๋Š”์ง€ ์•Œ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

2. ๊ธฐ์ˆ  ์Šคํƒ

FrontEnd

HTML5
CSS3
JavaScript
ย ย HTML5ย ย  ย ย ย ย CSS3ย ย ย ย  JavaScript
React
Recoil
Styled-components
ย ย ย ย ย Reactย ย ย ย ย  ย ย ย ย ย Recoilย ย ย ย ย  Styled-components
axios
OpenVidu
AXIOS OpenVidu

BackEnd

java
springboot
springsecurity
gradle
hibernate
Java Spring-Boot Spring-Security ย ย ย ย ย Gradleย ย ย ย ย  ย ย ย Hibernateย ย ย 
mysql
postman
websocket
redis
MariaDB Postman Websocket Redis

DevOps

docker
jenkins
nginx
EC2
S3
Docker Jenkins NginX AWS EC2 AWS S3

3. ํ•œ๋ˆˆ์— ๋ณด๋Š” ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜

system architecture

4. ํŒ€์› ์†Œ๊ฐœ

์ •์ƒ๊ธฐ (ํŒ€์žฅ): Frontend ๊ฐœ๋ฐœ + ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ ์†์˜ˆ์ง€ (ํŒ€์›): Frontend ๊ฐœ๋ฐœ + ๋””์ž์ธ ๊น€ํƒœ์› (ํŒ€์›): Frontend ์ด๊ด„ + QA ์ด์ง€์› (ํŒ€์›): Backend ์ด๊ด„ + QA ๋ณ€์œ ์ • (ํŒ€์›): Backend ๊ฐœ๋ฐœ + ์ด์Šˆ ๊ด€๋ฆฌ ์šฐ์ƒ๋นˆ (ํŒ€์›): Backend ๊ฐœ๋ฐœ + ์ด์Šˆ ๊ด€๋ฆฌ + ๋ฐœํ‘œ

5. Jira Convention

Jira๋Š” ๊ฐœ๋ฐœ ์ด์Šˆ ํŠธ๋ž™ํ‚น ์šฉ๋„๋กœ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

  • ๊ณ„์ธต

    1. epic (epic)
    2. story (FE), task (BE), bug (bug)
  • ์ด๋ฆ„ ๊ทœ์น™

    • Epic์€ ๋Œ€๋ถ„๋ฅ˜์ž…๋‹ˆ๋‹ค. FE, BE, bug ์ž‘์—…์˜ ๋ถ€๋ชจ ํ•ญ๋ชฉ์ž…๋‹ˆ๋‹ค.
    • FE, BE ์ž‘์—…์€ ๊ฐ๊ฐ ํ”„๋ก ํŠธ์—”๋“œ ์ž‘์—…๊ณผ ๋ฐฑ์—”๋“œ ์ž‘์—… ์„ธ๋ถ€ ์ด๋ฆ„์ž…๋‹ˆ๋‹ค. (ํ•œ๊ธ€๋กœ ์ƒ์„ธํžˆ ์ž‘์„ฑํ•ด ์ฃผ์„ธ์š”)
    • ์˜ˆ์‹œ) story [FE] ์œ ์ € ๋กœ๊ทธ์ธ ๋ ˆ์ด์•„์›ƒ ์ œ์ž‘
  • ์ด์Šˆ

    • ๋‹ด๋‹น์ž, ์šฐ์„ ์ˆœ์œ„, story point, Epic Link์™€ ํ•จ๊ป˜ ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜์„ธ์š”
    • Backlog ํƒญ์—์„œ ์ด์Šˆ๋ฅผ ๋ฏธ๋ฆฌ ๋งŒ๋“ค์–ด ๋†“๊ณ , ๋งค์ฃผ ์›”์š”์ผ ์•„์นจ ํšŒ์˜๋ฅผ ํ†ตํ•ด ์ด์Šˆ๋ฅผ ๊ฐœ์ธ๋ณ„๋กœ ํ• ๋‹นํ•ฉ๋‹ˆ๋‹ค. ํ• ๋‹นํ•œ ์ด์Šˆ๋ฅผ ์Šคํ”„๋ฆฐํŠธ์— ์˜ฎ๊ฒจ๋†“์œผ์„ธ์š”
    • ํ•ด๋‹น ์ด์Šˆ๋ฅผ ์™„๋ฃŒํ•˜๊ฑฐ๋‚˜ ์ž‘์—…์„ ์‹œ์ž‘ํ–ˆ๋‹ค๋ฉด, Active sprints ํƒญ์—์„œ workflow (Todo, In-progress, Done)์„ ๋ณ€๊ฒฝํ•ด์ฃผ์„ธ์š”
  • Burndown Chart

    • ๋ฒˆ๋‹ค์šด ์ฐจํŠธ๋Š” ์Šคํ”„๋ฆฐํŠธ๋ณ„ ์‹œ๊ฐ„๋‹น ์ž”์—ฌ Story-point ๋ฅผ ์ถ”์ ํ•ฉ๋‹ˆ๋‹ค
    • ์ฃผ์ฐจ๋ณ„ ์Šคํ”„๋ฆฐํŠธ๋ฅผ ์‹œ์ž‘ํ•˜๊ธฐ ์ „์— ๋ชจ๋“  ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜๊ณ  ํ• ๋‹นํ•ด์•ผ ์˜ฌ๋ฐ”๋ฅธ ๋ฒˆ๋‹ค์šด ์ฐจํŠธ๋ฅผ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค

6. Git Flow Convention

๋””๋ ‰ํ„ฐ๋ฆฌ ๊ตฌ์กฐ๋Š” frontend ์™€ backend ๋กœ ๊ตฌ๋ถ„๋ฉ๋‹ˆ๋‹ค. ๊ฐ ๊ฐœ๋ฐœ์ž๋“ค์€ ํ•ด๋‹น ๋””๋ ‰ํ„ฐ๋ฆฌ๋กœ ์ด๋™ํ•œ๋‹ค์Œ ์ž‘์—…ํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค

.
โ”œโ”€โ”€ frontend
โ””โ”€โ”€ backend

Branch Types

  • main: ์ œํ’ˆ์œผ๋กœ ์ถœ์‹œ๋  ์ˆ˜ ์žˆ๋Š” ๋ธŒ๋žœ์น˜
  • fe-develop: Frontend ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜
  • be-develop: Backend ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜
  • fe-feature: Frontend ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜
  • be-feature: Backend ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜
  • fe-hotfix: Frontend ๋ฒ„๊ทธ ์ˆ˜์ • ๋ธŒ๋žœ์น˜
  • be-hotfix: Backend ๋ฒ„๊ทธ ์ˆ˜์ • ๋ธŒ๋žœ์น˜

link

  1. origin/develop ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—… ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค
(fe-develop)]$ git fetch
(fe-develop)]$ git checkout -b fe-feature/user-login-layout --track origin/fe-develop
  1. ์ž‘์—… ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—…ํ•ฉ๋‹ˆ๋‹ค

  2. ์ž‘์—… ๋ธŒ๋žœ์น˜์—์„œ ์†Œ์Šค๋ฅผ ์ปค๋ฐ‹ํ•ฉ๋‹ˆ๋‹ค

(fe-feature/user-login-layout)]$ git commit -m "feat: add user login layout"
  1. ์ž‘์—… ๋ธŒ๋žœ์น˜๋ฅผ origin/develop์— rebase ํ•ฉ๋‹ˆ๋‹ค
(fe-feature/user-login-layout)]$ git pull --rebase origin fe-develop
  1. ์ž‘์—… ๋ธŒ๋žœ์น˜๋ฅผ origin์— pushํ•ฉ๋‹ˆ๋‹ค
(fe-feature/user-login-layout)]$ git push origin fe-feature/user-login-layout
  1. Gitlab์—์„œ ์ž‘์—… ๋ธŒ๋žœ์น˜๋ฅผ develop์— ํ•ฉ์น˜๋„๋ก Merge Request ๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค
  2. ๋™๋ฃŒ์—๊ฒŒ ์Šน์ธ๋ฐ›๊ณ , merge ํ•ฉ๋‹ˆ๋‹ค

7. Commit Message Convention

Commit Message Types

  • โ› fix: ๋‚ด ์ฝ”๋“œ๋ฒ ์ด์Šค์—์„œ ๋ฐœ์ƒํ•œ ๋ฒ„๊ทธ๋ฅผ ์ˆ˜์ •ํ–ˆ์„ ๋•Œ
  • โœจ feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ–ˆ์„ ๋•Œ
  • ๐Ÿ”Š (ELEMENT)!: API๋ฅผ ๋ฐ”๊ฟจ์„ ๋•Œ
  • ๐Ÿ“: docs: ๋ฌธ์„œ ์ˆ˜์ •
  • ๐Ÿ’ก refactor: ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋งํ–ˆ์„ ๋•Œ
  • ๐Ÿงช test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€ ๋˜๋Š” ์ˆ˜์ •ํ–ˆ์„ ๋•Œ
  • ๐ŸŽจ style: ์ฝ”๋“œ ํ˜•์‹ ๋ฐ”๊ฟจ์„ ๋•Œ
  • ๐Ÿ’ซ chore: ๊ทธ ์™ธ ๊ธฐํƒ€์‚ฌํ•ญ
  • fix ์™€ feat ์™ธ ํƒ€์ž…๋“ค
  • Examples:
~/SSAFY/my-app (be-feature/login) $ git commit -m " feat: allow provided config object to extend other configs"
~/SSAFY/my-app (be-feature/login) $ git commit -m "feat: check if ID is duplicated"
~/SSAFY/my-app (be-feature/login) $ git commit -m "feat!: send an email to the customer when a product is shipped"
~/SSAFY/my-app (be-feature/login) $ git commit -m "docs: correct spelling of CHANGELOG"

8. Backend Convention

// backend ๋””๋ ‰ํ„ฐ๋ฆฌ ์•ˆ์—์„œ
.
โ””โ”€โ”€ main                            // java src ๋””๋ ‰ํ„ฐ๋ฆฌ
    โ”œโ”€โ”€ java
    โ”‚ย ย  โ””โ”€โ”€ com
    โ”‚ย ย      โ””โ”€โ”€ underAuction
    โ”‚ย ย          โ”œโ”€โ”€ api                 // REST API ๋””๋ ‰ํ„ฐ๋ฆฌ
    โ”‚ย ย          โ”‚ย ย  โ”œโ”€โ”€ controller
    โ”‚ย ย          โ”‚ย ย  โ”œโ”€โ”€ request
    โ”‚ย ย          โ”‚ย ย  โ”œโ”€โ”€ response
    โ”‚ย ย          โ”‚ย ย  โ””โ”€โ”€ service
    โ”‚ย ย          โ”œโ”€โ”€ common              // ๊ณต์šฉ ์œ ํ‹ธ ๋””๋ ‰ํ„ฐ๋ฆฌ
    โ”‚ย ย          โ”‚ย ย  โ”œโ”€โ”€ auth
    โ”‚ย ย          โ”‚ย ย  โ”œโ”€โ”€ exception
    โ”‚ย ย          โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ handler
    โ”‚ย ย          โ”‚ย ย  โ”œโ”€โ”€ model
    โ”‚ย ย          โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ response
    โ”‚ย ย          โ”‚ย ย  โ””โ”€โ”€ util
    โ”‚ย ย          โ”œโ”€โ”€ config              // ํ”Œ๋Ÿฌ๊ทธ์ธ ์„ค์ • ๋””๋ ‰ํ„ฐ๋ฆฌ
    โ”‚ย ย          โ”œโ”€โ”€ db                  // ๋””๋น„ ๋””๋ ‰ํ„ฐ๋ฆฌ
    โ”‚ย ย              โ”œโ”€โ”€ entity
    โ”‚ย ย              โ””โ”€โ”€ repository
    โ””โ”€โ”€ resources                    // ์›น ๋ฆฌ์†Œ์Šค ๋””๋ ‰ํ„ฐ๋ฆฌ
        โ”œโ”€โ”€ README.md
        โ””โ”€โ”€ application.properties

9. Frontend Convention

// frontend ๋””๋ ‰ํ„ฐ๋ฆฌ ์•ˆ์—์„œ
.
โ”œโ”€โ”€ public          // ์†Œ์Šค ์ฝ”๋“œ์—์„œ ์ฐธ์กฐ๋˜์ง€ ์•Š๋Š” ์—์…‹
โ”œโ”€โ”€ src             // ์†Œ์Šค ์ฝ”๋“œ
โ”‚   โ”œโ”€โ”€ api             // ์„œ๋ฒ„์™€ ํ†ต์‹ ์— ์“ฐ์ด๋Š” api
โ”‚   โ”œโ”€โ”€ assets          // ์†Œ์Šค ์ฝ”๋“œ์—์„œ ์ฐธ์กฐ๋˜๋Š” ์—์…‹
โ”‚   โ”œโ”€โ”€ components      // ์ปดํฌ๋„ŒํŠธ ๋””๋ ‰ํ„ฐ๋ฆฌ
โ”‚   โ”‚   โ”œโ”€โ”€ Layout
โ”‚   โ”‚   โ””โ”€โ”€ User
โ”‚   โ”œโ”€โ”€ pages           // ํŽ˜์ด์ง€ ๋””๋ ‰ํ„ฐ๋ฆฌ
โ”‚   โ””โ”€โ”€ store           // Recoil ๋””๋ ‰ํ„ฐ๋ฆฌ
โ””โ”€โ”€ types           // ํƒ€์ž… ์„ ์–ธ ๋””๋ ‰ํ„ฐ๋ฆฌ

10. Wire Frames

  • ์œ ์ € ํ™”๋ฉด ํ”„๋ ˆ์ž„๋“ค

    login signup reset-password set-category

  • ๋ฉ”์ธ ํ™”๋ฉด ํ”„๋ ˆ์ž„๋“ค

    notification-live main-0 main-1 main-2

  • ํ•˜์œ„ ๋ฉ”์ธ ํ™”๋ฉด ํ”„๋ ˆ์ž„๋“ค

    ๊ด€์‹ฌ๋ชฉ๋ก-๋‚ด์ฐœ ๊ด€์‹ฌ๋ชฉ๋ก-์ž…์žฅ์˜ˆ์ • ์ž๋™๊ฒฝ๋งค ์•Œ๋žŒ๋ฆฌ์ŠคํŠธ

  • ๊ฒฝ๋งค ํ™”๋ฉด ํ”„๋ ˆ์ž„๋“ค

๊ฒฝ๋งค๋ผ์ด๋ธŒ-ํŒ๋งค์ž ๊ฒฝ๋งค๋ผ์ด๋ธŒ-๊ตฌ๋งค์ž ๊ฒฝ๋งค๋ฐฉ ์ƒ์„ฑ ๋‚™์ฐฐ์‹œ-๋ชจ๋‹ฌ

11. ๊ธฐ๋Šฅ ์ •์˜์„œ

  • ์ „์ฒด์  ํ๋ฆ„๋„

    basic

  • ์ž๋™ ๊ฒฝ๋งค ํ๋ฆ„๋„

    auction

12. ERD

Auctopus ERD

13. Sequence Diagram

login auction

14. References

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors