Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

๐Ÿš€ 1๋‹จ๊ณ„ - ์šฉ์–ด ์‚ฌ์ „ ๋งŒ๋“ค๊ธฐ #430

Open
wants to merge 1 commit into
base: jiokim
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 79 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,84 @@ docker compose -p kitchenpos up -d

## ์šฉ์–ด ์‚ฌ์ „

| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
| --- | --- | --- |
| | | |
### ๊ณตํ†ต

| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|------|------------|---------------|
| ๋น„์†์–ด | profanity | ์š•์„ค ๋˜๋Š” ์ €์†ํ•œ ํ‘œํ˜„. |

### ์ƒํ’ˆ

| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|------|---------------|------------------------------------|
| ์ƒํ’ˆ | Product | ๊ณ ๊ฐ์—๊ฒŒ ํŒ๋งค๋ฅผ ๋ชฉ์ ์œผ๋กœ ๋ณด์œ ํ•œ ๋ฌผ๊ฑด์œผ๋กœ ๋ฉ”๋‰ด๋ฅผ ๊ตฌ์„ฑํ•˜๋Š” ๋‹จ์œ„ |
| ์ƒํ’ˆ์ด๋ฆ„ | Product Name | ์ƒํ’ˆ์˜ ์ด๋ฆ„, ๋น„์†์–ด๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋‹ค. |
| ์ƒํ’ˆ๊ฐ€๊ฒฉ | Product Price | ์ƒํ’ˆ์˜ ๊ฐ€๊ฒฉ, 0์› ์ด์ƒ์ด์—ฌ์•ผ ํ•œ๋‹ค. |

### ๋ฉ”๋‰ด๊ทธ๋ฃน

| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|----------|-----------------|--------------------------------|
| ๋ฉ”๋‰ด ๊ทธ๋ฃน | Menu Group | ๋ฉ”๋‰ด์˜ ์ง‘ํ•ฉ์ด๋ฉฐ, ๋ฉ”๋‰ด๋Š” ํŠน์ •ํ•œ ๋ฉ”๋‰ด๊ทธ๋ฃน์— ์†ํ•ด์•ผํ•œ๋‹ค. |
| ๋ฉ”๋‰ด ๊ทธ๋ฃน ์ด๋ฆ„ | Menu Group Name | ๋ฉ”๋‰ด ๊ทธ๋ฃน์˜ ์ด๋ฆ„, ๋น„์†์–ด๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋‹ค. |

### ๋ฉ”๋‰ด

| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|----------|----------------|------------------------------|
| ๋ฉ”๋‰ด | Menu | ์ƒํ’ˆ์˜ ์ง‘ํ•ฉ์ด๋ฉฐ, 1๊ฐœ ์ด์ƒ์˜ ์ƒํ’ˆ์œผ๋กœ ๊ตฌ์„ฑ๋œ๋‹ค. |
| ๋ฉ”๋‰ด ์ด๋ฆ„ | Menu Name | ๋ฉ”๋‰ด์˜ ์ด๋ฆ„, ๋น„์†์–ด๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋‹ค. |
| ๋ฉ”๋‰ด ๊ฐ€๊ฒฉ | Menu Price | ๋ฉ”๋‰ด์˜ ๊ฐ€๊ฒฉ, 0์› ์ด์ƒ์ด์—ฌ์•ผ ํ•œ๋‹ค. |
| ๋ฉ”๋‰ด ์ƒํ’ˆ | Menu Product | ์ƒํ’ˆ๊ณผ ์ˆ˜๋Ÿ‰์œผ๋กœ ๊ตฌ์„ฑ๋œ๋‹ค. |
| ๋ฉ”๋‰ด ๊ณต๊ฐœ ์ƒํƒœ | Menu Displayed | ๋ฉ”๋‰ด์˜ ๊ณต๊ฐœ ์ƒํƒœ๋ฅผ ๋‚˜ํƒ€๋‚ธ๋‹ค. ex) ๊ณต๊ฐœ, ๋น„๊ณต๊ฐœ |

### ์ฃผ๋ฌธํ…Œ์ด๋ธ”
| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|-----------|------------------|--------------------------------|
| ์ฃผ๋ฌธ ํ…Œ์ด๋ธ” | Order Table | ๋งค์žฅ ๋‚ด์—์„œ ๊ณ ๊ฐ์ด ์‹์‚ฌํ•  ์ˆ˜ ์žˆ๋Š” ํ…Œ์ด๋ธ”์„ ๋‚˜ํƒ€๋‚ธ๋‹ค. |
| ์ฃผ๋ฌธ ํ…Œ์ด๋ธ” ์ด๋ฆ„ | Order Table Name | ํ…Œ์ด๋ธ”์˜ ์ด๋ฆ„, ๋น„์†์–ด๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋‹ค. |
| ์ฃผ๋ฌธ ํ…Œ์ด๋ธ” ์ธ์› | Number Of Guests | ์ฃผ๋ฌธ ํ…Œ์ด๋ธ”์„ ์‚ฌ์šฉํ•˜๋Š” ๊ณ ๊ฐ์˜ ์ˆ˜๋ฅผ ๋‚˜ํƒ€๋‚ธ๋‹ค. |
| ํ…Œ์ด๋ธ” ์ ์œ  ์ƒํƒœ | Occupied | ํ…Œ์ด๋ธ”์˜ ์ ์œ  ์ƒํƒœ๋ฅผ ๋‚˜ํƒ€๋‚ธ๋‹ค. ex) ์ ์œ , ๋ฏธ์ ์œ  |

### ์ฃผ๋ฌธ

| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|---------|------------------|--------------------------------------------------------------------|
| ์ฃผ๋ฌธ | Order | ๊ณ ๊ฐ์ด ์ฃผ๋ฌธํ•œ ์ƒํ’ˆ์ •๋ณด๋ฅผ ๋‚˜ํƒ€๋‚ธ๋‹ค. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

๋ฌผ๋ก  ์ฃผ๋ฌธ์—๋Š” ์ƒํ’ˆ์ •๋ณด๊ฐ€ ๋“ค์–ด๊ฐ€ ์žˆ์ง€๋งŒ ์ฃผ๋ฌธ์ด๋ผ๋Š” ํ–‰์œ„์ ์ธ ์ธก๋ฉด์—์„œ์˜ ์„ค๋ช…์„ ์ถ”๊ฐ€ํ•ด ๋ณด๋ฉด ์–ด๋–จ๊นŒ์š”?

์ฐธ๊ณ ์šฉ ์˜ˆ์‹œ
๊ณ ๊ฐ์ด ์Œ์‹์„ ์š”์ฒญํ•˜๊ณ  ์ „๋‹ฌ ๋ฐ›๊ธฐ๊นŒ์ง€์˜ ํ”„๋กœ์„ธ์Šค

| ์ฃผ๋ฌธ ์•„์ดํ…œ | Order Line Item | ๊ณ ๊ฐ์ด ์ฃผ๋ฌธํ•œ ์ƒํ’ˆ ๋ชฉ๋ก ์ •๋ณด(๋ฉ”๋‰ด, ์ˆ˜๋Ÿ‰). |
| ์ฃผ๋ฌธ ๊ฐ€๊ฒฉ | Order Line Price | ์ฃผ๋ฌธํ•œ ๋ฉ”๋‰ด์˜ ์ด ๊ฐ€๊ฒฉ. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

์ฃผ๋ฌธ ๊ฐ€๊ฒฉ์„ ์ •์˜ํ•˜์…จ์œผ๋‹ˆ ์ฃผ๋ฌธ ์ˆ˜๋Ÿ‰๋„ ์ด์–ด์„œ ์ •์˜ํ•˜๋ฉด ์ข‹์„ ๊ฒƒ ๊ฐ™์•„์š”. ๐Ÿ˜„

| ์ฃผ๋ฌธ ์ข…๋ฅ˜ | Order Type | ์ฃผ๋ฌธ์˜ ํƒ€์ž…์€ ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ(TAKEOUT), ํฌ์žฅ ์ฃผ๋ฌธ(TAKEOUT), ๋งค์žฅ ์ฃผ๋ฌธ(EAT_IN) 3๊ฐ€์ง€ ์ข…๋ฅ˜์„ ๊ฐ–๋Š”๋‹ค. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

์˜คํƒ€๊ฐ€ ์žˆ๋„ค์š”? ๐Ÿ˜…

Suggested change
| ์ฃผ๋ฌธ ์ข…๋ฅ˜ | Order Type | ์ฃผ๋ฌธ์˜ ํƒ€์ž…์€ ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ(TAKEOUT), ํฌ์žฅ ์ฃผ๋ฌธ(TAKEOUT), ๋งค์žฅ ์ฃผ๋ฌธ(EAT_IN) 3๊ฐ€์ง€ ์ข…๋ฅ˜์„ ๊ฐ–๋Š”๋‹ค. |
| ์ฃผ๋ฌธ ์ข…๋ฅ˜ | Order Type | ์ฃผ๋ฌธ์˜ ํƒ€์ž…์€ ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ(DELIVERY), ํฌ์žฅ ์ฃผ๋ฌธ(TAKEOUT), ๋งค์žฅ ์ฃผ๋ฌธ(EAT_IN) 3๊ฐ€์ง€ ์ข…๋ฅ˜์„ ๊ฐ–๋Š”๋‹ค. |


#### ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ(Delivery Order)
| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|---------------|------------------|---------------------------|
| ์ฃผ๋ฌธ ์ข…๋ฅ˜(๋ฐฐ๋‹ฌ) | DELIVERY | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ ์ข…๋ฅ˜. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ํ•œ๊ธ€๋ช…์˜ ์ฃผ๋ฌธ ์ข…๋ฅ˜ ๋‹จ์–ด๋Š” ์„ค๋ช…์˜ ์ฃผ๋ฌธ ์ข…๋ฅ˜์™€ ์ค‘๋ณต๋˜์–ด ํ‘œํ˜„๋˜๊ณ  ์žˆ์œผ๋‹ˆ
ํ•œ๊ธ€๋ช…์€ ๊ทธ๋ƒฅ ์‚ฌ์ „๋‹ต๊ฒŒ ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ ์šฉ์–ด๋งŒ ๊ฐ„๊ฒฐํ•˜๊ฒŒ ๊ธฐ์ˆ ํ•˜๋Š” ๊ฑด ์–ด๋–จ๊นŒ์š”? ๐Ÿค”

| ์ฃผ๋ฌธ ์ƒํƒœ(์ ‘์ˆ˜ ๋Œ€๊ธฐ์ค‘) | WAITING | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ์ ‘์ˆ˜์™„๋ฃŒ ๋˜๊ธฐ ์ „ ์ƒํƒœ. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

์ฃผ๋ฌธ ์ƒํƒœ๋ผ๋Š” ๋‹จ์–ด๊ฐ€ ํ•œ๊ธ€๋ช…์—์„œ ๊ณ„์† ๋ฐ˜๋ณต๋˜๊ณ  ์žˆ๋Š”๋ฐ,
์„ค๋ช…๋ž€์—์„œ ์ด๋ฏธ ์ƒํƒœ๋ผ๊ณ  ๊ธฐ์ˆ ํ•˜๊ณ  ์žˆ์œผ๋‹ˆ ํ•œ๊ธ€๋ช…์€ ๊ทธ๋ƒฅ ์ ‘์ˆ˜ ๋Œ€๊ธฐ์ค‘์œผ๋กœ๋งŒ ํ‘œํ˜„ํ•ด๋„ ๊ดœ์ฐฎ์„ ๊ฒƒ ๊ฐ™์€๋ฐ ์–ด๋–ป๊ฒŒ ์ƒ๊ฐํ•˜์„ธ์š”? ๐Ÿค”

| ์ฃผ๋ฌธ ์ƒํƒœ(์ ‘์ˆ˜ ์™„๋ฃŒ) | ACCEPTED | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ์ ‘์ˆ˜์™„๋ฃŒ๋œ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์„œ๋น™ ์™„๋ฃŒ) | SERVED | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ์„œ๋น™์™„๋ฃŒ ์ƒํƒœ. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| ์ฃผ๋ฌธ ์ƒํƒœ(์„œ๋น™ ์™„๋ฃŒ) | SERVED | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ์„œ๋น™์™„๋ฃŒ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์„œ๋น™ ์™„๋ฃŒ) | SERVED | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ์„œ๋น™์™„๋ฃŒ๋œ ์ƒํƒœ. |

| ์ฃผ๋ฌธ ์ƒํƒœ(๋ฐฐ๋‹ฌ ์ค‘) | DELIVERING | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ๋ฐฐ๋‹ฌ์ค‘์ธ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(๋ฐฐ๋‹ฌ ์™„๋ฃŒ) | DELIVERED | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ๋ฐฐ๋‹ฌ์™„๋ฃŒ์ธ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์ฃผ๋ฌธ ์™„๋ฃŒ) | COMPLETED | ๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์ด ์™„๋ฃŒ๋œ ์ƒํƒœ. |
| ๋ฐฐ๋‹ฌ ๋Œ€ํ–‰์‚ฌ | Delivery Agent | ์ฃผ๋ฌธ์„ ๋ฐฐ๋‹ฌํ•ด ์ฃผ๋Š” ์„œ๋น„์Šค๋ฅผ ์ œ๊ณตํ•˜๋Š” ๋Œ€ํ–‰์‚ฌ. |
| ๋ฐฐ๋‹ฌ ์ฃผ์†Œ | Delivery Address | ๋ฐฐ๋‹ฌ ์ฃผ์†Œ. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

์„ค๋ช…์„ ํ•œ๊ธ€๋ช…๊ณผ ๋™์ผํ•˜๊ฒŒ ์ ๊ธฐ๋ณด๋‹จ ์กฐ๊ธˆ ๋” ํ’€์–ด์„œ ์ ์–ด์ฃผ๋ฉด ์–ด๋–จ๊นŒ์š”?

์ฐธ๊ณ ์šฉ ์˜ˆ์‹œ
๋ฐฐ๋‹ฌ ์ฃผ๋ฌธ์˜ ์Œ์‹์„ ์ „๋‹ฌ ํ•  ์ฃผ์†Œ์ง€


#### ํฌ์žฅ ์ฃผ๋ฌธ(TakeOut Order)
| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|---------------|-----------|--------------------|
| ์ฃผ๋ฌธ ์ข…๋ฅ˜(ํฌ์žฅ) | TAKEOUT | ํฌ์žฅ ์ฃผ๋ฌธ ์ข…๋ฅ˜. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์ ‘์ˆ˜ ๋Œ€๊ธฐ์ค‘) | WAITING | ํฌ์žฅ ์ฃผ๋ฌธ์ด ์ ‘์ˆ˜๋˜๊ธฐ ์ „ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์ ‘์ˆ˜ ์™„๋ฃŒ) | ACCEPTED | ํฌ์žฅ ์ฃผ๋ฌธ์ด ์ ‘์ˆ˜ ์™„๋ฃŒ๋œ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์„œ๋น™ ์™„๋ฃŒ) | SERVED | ํฌ์žฅ ์ฃผ๋ฌธ์„ ์ˆ˜๋ น ๊ฐ€๋Šฅํ•œ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์ฃผ๋ฌธ ์™„๋ฃŒ) | COMPLETED | ํฌ์žฅ ์ฃผ๋ฌธ์„ ์ˆ˜๋ นํ•œ ์ƒํƒœ. |

#### ๋งค์žฅ ์ฃผ๋ฌธ(EatIn Order)
| ํ•œ๊ธ€๋ช… | ์˜๋ฌธ๋ช… | ์„ค๋ช… |
|---------------|-----------|--------------------------|
| ์ฃผ๋ฌธ ์ข…๋ฅ˜(๋งค์žฅ) | EAT_IN | ๋งค์žฅ ์ฃผ๋ฌธ ์ข…๋ฅ˜. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์ ‘์ˆ˜ ๋Œ€๊ธฐ์ค‘) | WAITING | ๋งค์žฅ ์ฃผ๋ฌธ์ด ์ ‘์ˆ˜๋˜๊ธฐ ์ „ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์ ‘์ˆ˜ ์™„๋ฃŒ) | ACCEPTED | ๋งค์žฅ ์ฃผ๋ฌธ์ด ์ ‘์ˆ˜ ์™„๋ฃŒ๋œ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์„œ๋น™ ์™„๋ฃŒ) | SERVED | ๋งค์žฅ ์ฃผ๋ฌธ์ด ๋งค์žฅ ํ…Œ์ด๋ธ”์— ์„œ๋น™์™„๋ฃŒ๋œ ์ƒํƒœ. |
| ์ฃผ๋ฌธ ์ƒํƒœ(์ฃผ๋ฌธ ์™„๋ฃŒ) | COMPLETED | ๋งค์žฅ ์ฃผ๋ฌธ์ด ์™„๋ฃŒ๋œ ์ƒํƒœ. |


## ๋ชจ๋ธ๋ง