Skip to content

Latest commit

ย 

History

History
330 lines (271 loc) ยท 13.2 KB

README.md

File metadata and controls

330 lines (271 loc) ยท 13.2 KB

๐Ÿ“‹ Handover - ๊ตญ๋ฐฉ์—…๋ฌด๊ณต์œ ์ฒด๊ณ„


Handover Logo

Documentationย ย |ย ย Presentationย ย |ย ย Demo Video

GitHub language count GitHub language count GitHub language count

๐Ÿ‘‹ ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ (Project Introduction)

Handover๋Š” ๊ตฐ ๋‚ด์˜ ์ธ์ˆ˜์ธ๊ณ„๋ฅผ ํšจ์œจ์ ์ด๊ณ  ํŽธ๋ฆฌํ•˜๊ฒŒ ์ง„ํ–‰ํ•  ์ˆ˜ ์žˆ๋„๋ก ๋•๋Š” Web ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค.

Handover๋Š” ๋ณด์ง ๋ณ€๊ฒฝ ๋“ฑ์˜ ์ƒํ™ฉ์—์„œ ํšจ์œจ์ ์ด๊ณ  ์ •ํ™•ํ•˜์ง€ ์•Š์€ ์ธ์ˆ˜์ธ๊ณ„๋กœ ์ธํ•ด
์ƒˆ๋กœ์šด ์—…๋ฌด ํ™˜๊ฒฝ์— ์ ์‘ํ•˜๋Š” ๊ฒƒ์— ์–ด๋ ค์›€์„ ๊ฒช๊ฑฐ๋‚˜ ์—…๋ฌด์˜ ๊ณต๋ฐฑ์ด ์ƒ๊ธฐ๋Š” ๋ฌธ์ œ์ ์„ ํ•ด๊ฒฐํ•˜๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค.

๋” ๋‚˜์•„๊ฐ€, ๋ถ€๋Œ€ ๊ฐ„ ํšจ์œจ์ ์ธ ์—…๋ฌด ๋ฐฉ๋ฒ•์„ ๊ณต์œ ํ•˜๋Š”
ํ†ตํ•ฉ์  ์—…๋ฌด ๊ณต์œ  ํ”Œ๋žซํผ์„ ์ œ๊ณตํ•˜๋Š” ๊ฒƒ์„ ๋ชฉํ‘œ๋กœ ํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿ“– ๋ชฉ์ฐจ

  1. ๊ธฐ๋Šฅ ์„ค๋ช…
  2. ์ปดํ“จํ„ฐ ๊ตฌ์„ฑ / ํ•„์ˆ˜ ์กฐ๊ฑด ์•ˆ๋‚ด
  3. ๊ธฐ์ˆ  ์Šคํƒ
  4. ๊ธฐ๋Œ€ ํšจ๊ณผ
  5. ๊ฒฝ์Ÿ๋ ฅ
  6. ์„ค์น˜ ์•ˆ๋‚ด
  7. ํ”„๋กœ์ ํŠธ ์‚ฌ์šฉ๋ฒ•
  8. Handover์— ๊ธฐ์—ฌํ•˜๋Š” ๋ฒ•
  9. ์†Œ์Šค์ฝ”๋“œ ๊ตฌ์กฐ
  10. ํŒ€ ์ •๋ณด
  11. ์ €์ž‘๊ถŒ ๋ฐ ์‚ฌ์šฉ๊ถŒ ์ •๋ณด

โœจ ๊ธฐ๋Šฅ ์„ค๋ช… (Key Features)

Handover๋งŒ์˜ 3๊ฐ€์ง€ ํ•ต์‹ฌ ๊ธฐ๋Šฅ๊ณผ ํ•จ๊ป˜ ๋” ํŽธ๋ฆฌํ•˜๊ณ  ๋˜‘๋˜‘ํ•œ ์ธ์ˆ˜์ธ๊ณ„๋ฅผ ์ง„ํ–‰ํ•ด๋ณด์„ธ์š”!

  • 3๋‹จ๊ณ„ ๋ฌธ์„œ ๊ตฌ์„ฑ ์œผ๋กœ ์ฒด๊ณ„์ ์ธ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
  • ๊ทธ๋ฃน, ๋ถ๋งˆํฌ, ๋Œ“๊ธ€ ๊ธฐ๋Šฅ๋“ค๋กœ ๊ณต์œ ํ•˜๋Š” ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
  • ๋ณด์•ˆ ๊ด€๋ฆฌ์ž ๊ธฐ๋Šฅ์œผ๋กœ ๋ณด์•ˆ์œ„๋ฐ˜์œผ๋กœ๋ถ€ํ„ฐ ์•ˆ์ „ํ•œ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ

๐Ÿ—„๏ธ 3๋‹จ๊ณ„ ๋ฌธ์„œ ๊ตฌ์„ฑ

Handover ๋‚ด์˜ ๋ชจ๋“  ๋ฌธ์„œ๋Š” ๐Ÿ—„๏ธ ์„œ๋ž, ๐Ÿ“ฐ ๋ฌธ์„œ, ๐Ÿ“‡ ์นด๋“œ ์˜ 3๋‹จ๊ณ„ ๊ตฌ์„ฑ์„ ๊ฐ–์Šต๋‹ˆ๋‹ค.

  • ์„œ๋ž: ๋ถ€์„œ ๋˜๋Š” ๋ณด์ง์— ์—ฐ๊ด€๋œ ๋ฌธ์„œ๋“ค์˜ ์ง‘ํ•ฉ
  • ๋ฌธ์„œ: ํ•˜๋‚˜์˜ ์—…๋ฌด๋ฅผ ๊ตฌ์„ฑํ•˜๋Š” ์นด๋“œ๋“ค์˜ ์ง‘ํ•ฉ
  • ์นด๋“œ: ์ž‘์€ ์—…๋ฌด๋ฅผ ์ˆ˜ํ–‰ํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ์„ค๋ช…ํ•œ ์งง์€ ๊ธ€

3๋‹จ๊ณ„ ๋ฌธ์„œ ๊ตฌ์„ฑ๊ณผ ๋ฌธ์„œ ์ž‘์„ฑ ๊ฐ€์ด๋“œ๋ฅผ ํ†ตํ•ด ๋” ์ฝ๊ธฐ ์‰ฝ๊ณ , ์ฒด๊ณ„ํ™”๋œ ๋ฌธ์„œ๋ฅผ ์ž‘์„ฑํ•ด๋ณด์„ธ์š”!

๐Ÿค ๋ฌธ์„œ ๊ณต์œ  ์„œ๋น„์Šค

  • ๊ฐ™์€ ๋ณด์ง, ๊ฐ™์€ ์†Œ์†์˜ ์‚ฌ์šฉ์ž๋“ค๊ณผ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ๋ฅผ ๊ณต์œ ํ•˜๊ณ , ๋Œ“๊ธ€์„ ํ†ตํ•ด ์˜๊ฒฌ์„ ๋‚˜๋ˆ„์–ด๋ณด์„ธ์š”!
  • ๋งˆ์Œ์— ๋“œ๋Š” ๋ฌธ์„œ๊ฐ€ ์žˆ๋‹ค๋ฉด, ๋ถ๋งˆํฌ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ์–ธ์ œ๋“ ์ง€ ๋ฌธ์„œ๋ฅผ ๋‹ค์‹œ ์—ด๋žŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿ” ๋ณด์•ˆ ๊ด€๋ฆฌ์ž ๋“ฑ๋ก์„ ํ†ตํ•œ ๊ธฐ๋ฐ€ ์œ ์ถœ ๋ฐฉ์ง€

  • ๊ทธ๋ฃน ๋ณ„๋กœ ๋ณด์•ˆ ๊ด€๋ฆฌ์ž๋ฅผ ๋“ฑ๋กํ•ด ๊ทธ๋ฃน ๋‚ด ๋ฌธ์„œ์—์„œ ๋ณด์•ˆ ์‚ฌํ•ญ์ด ์œ„๋ฐ˜๋˜๊ณ  ์žˆ๋Š”์ง€ ํ™•์ธํ•˜๊ณ , ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿ”Ž ์ปดํ“จํ„ฐ ๊ตฌ์„ฑ / ํ•„์ˆ˜ ์กฐ๊ฑด ์•ˆ๋‚ด (Prerequisites)

Chrome Edge FireFox Safari
โœ” (84+) โœ” (84+) โœ” (63+) โœ” (14.1+)

โœจ Handover ์˜ ๊ธฐ๋Œ€ํšจ๊ณผ (Expectations)

๐Ÿ‘ ์ธ์ˆ˜์ธ๊ณ„ ๋ฐฉ์‹์˜ ์ฒด๊ณ„ํ™”

  • ๊ณตํ†ต๋œ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ ์ž‘์„ฑ ํ”Œ๋žซํผ์„ ํ†ตํ•œ ์ธ์ˆ˜์ธ๊ณ„ ๋ฐฉ์‹ ํ†ต์ผ
  • 3๋‹จ๊ณ„ ๋ฌธ์„œ ๊ตฌ์„ฑ์„ ํ†ตํ•œ ์ธ์ˆ˜์ธ๊ณ„์˜ ํšจ์œจ์„ฑ ๋ฐ ์ •ํ™•๋„ ํ–ฅ์ƒ
  • ์ธ์ˆ˜์ธ๊ณ„ ๋ฐฉ์‹์˜ ๊ฐœ์„ ์œผ๋กœ ๊ตฐ ์žฅ๋ณ‘์˜ ์—…๋ฌด ์ ์‘๊ธฐ๊ฐ„ ๋‹จ์ถ• ๊ธฐ๋Œ€

๐Ÿค ๋ถ€๋Œ€ ๊ฐ„ ์ •๋ณด ๊ณต์œ  ํ™•๋Œ€

  • ์—…๋ฌด ๋ฌธ์„œ๋ฅผ ๊ณต์œ ํ•ด ๋ถ€๋Œ€ ๊ฐ„ ์†Œํ†ต ํ™•๋Œ€
  • ์‚ฌ์šฉ์ž๋“ค์˜ ์˜๊ฒฌ ๊ณต์œ ๋ฅผ ํ†ตํ•œ ์—…๋ฌด ํšจ์œจ์„ฑ ์ƒ์Šน
  • ๋…ธํ•˜์šฐ ๊ณต์œ ๋ฅผ ํ†ตํ•œ ์—…๋ฌด ๋Šฅ๋ฅ  ์ฆํญ

๐Ÿ”ฅ Handover ๊ฐ€ ๊ฐ€์ง„ ๊ฒฝ์Ÿ๋ ฅ (Competitiveness)

๐Ÿ“Š ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ์˜ ๋ฐ์ดํ„ฐํ™”

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

๐Ÿ“– ์˜คํ”ˆ์†Œ์Šค๋กœ์จ์˜ Handover

  • API Doc, Database Schema๋ฅผ ์ œ๊ณตํ•จ์œผ๋กœ์จ ์˜คํ”ˆ์†Œ์Šค ๊ฐœ๋ฐœ์ž๋“ค์˜ ์ง€์†์  ๊ฐœ๋ฐœ ์ง€์›
  • Editor๋‚ด ํ‘œ ์ž‘์„ฑ, ์ˆ˜์‹ ์ž‘์„ฑ ๊ธฐ๋Šฅ ๋“ฑ ์‚ฌ์šฉ์ž๋“ค์ด ํ•„์š”๋กœ ํ•˜๋Š” ๊ธฐ๋Šฅ๋“ค์„ ์ถ”๊ฐ€ํ•˜๋ฉฐ ์„ฑ์žฅ ๊ฐ€๋Šฅ

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

๐Ÿš‰ Platform

๐Ÿ›’ Back-end

๐Ÿ’„ Front-end

๐Ÿš€ ์„ค์น˜ ์•ˆ๋‚ด (Installation Methods)

1. Repository Clone

ํ„ฐ๋ฏธ๋„(๋˜๋Š” ์ฝ˜์†”)์—์„œ ๋‹ค์Œ ๋ช…๋ น์–ด ์‹คํ–‰

git clone https://github.com/osamhack2021/Web_Handover_Handover.git handover && cd handover

2. Docker ์„ค์ •

์‚ฌ์šฉํ•˜๋Š” ์šด์˜์ฒด์ œ์— ๋งž๋Š” Docker ์„ค์น˜

3. Docker ์‹คํ–‰

ํ”„๋กœ์ ํŠธ root ํด๋”์—์„œ ํ„ฐ๋ฏธ๋„์„ ์—ด๊ณ  ๋‹ค์Œ ๋ช…๋ น์–ด ์‹คํ–‰

npm run prd

4. ํ”„๋กœ์ ํŠธ ์‹คํ–‰ ํ™•์ธ

localhost ์—์„œ ์„œ๋น„์Šค๋˜๊ณ  ์žˆ๋Š” Handover ํ™•์ธ

5. Docker ์ค‘์ง€

Ctrl + C ๋ฅผ ๋ˆŒ๋Ÿฌ์„œ ํ„ฐ๋ฏธ๋„์—์„œ ์‹คํ–‰๋˜๋˜ Docker ์ค‘์ง€

๐Ÿƒ ํ”„๋กœ์ ํŠธ ์‚ฌ์šฉ๋ฒ• (Getting Started)

Handover๋Š” ๋ณ„๋„์˜ ์„ค์ •์ด๋‚˜ ๋ฉ”๋‰ด์–ผ ์—†์ด๋„ ์ง๊ด€์ ์ธ UI๋ฅผ ํ†ตํ•ด ๋ฐ”๋กœ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค!

๐Ÿ™Œ Handover์— ๊ธฐ์—ฌํ•˜๋Š” ๋ฒ• (How to contribute)

Handover๋Š” ์˜คํ”ˆ์†Œ์Šค ํ”„๋กœ์ ํŠธ๋กœ, ์—ฌ๋Ÿฌ๋ถ„๋“ค์˜ ๋„์›€์„ ๊ธฐ๋‹ค๋ฆฌ๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.
Handover์— ๊ธฐ์—ฌํ•˜๊ณ  ์‹ถ์œผ์‹œ๋‹ค๋ฉด, CONTRIBUTING.md ์„ ์ฐธ๊ณ ํ•ด์ฃผ์„ธ์š”.

๐Ÿ•น๏ธ ์†Œ์Šค์ฝ”๋“œ ๊ตฌ์กฐ (Source Code Structure)

WEB(FE)

/frontend

WEB(BE)

/backend

๐Ÿ‘จโ€๐Ÿ‘ฆโ€๐Ÿ‘ฆ ํŒ€ ์ •๋ณด (Team Info)

์‚ฌ์ง„
์ด๋ฆ„ ์กฐ๋‚˜๋‹จ ์•ˆ์ˆ˜๊ฒธ ๊น€ํƒœ์› ์ตœ์šฐํ˜ ๋ฐ•ํ˜„์ค€ ์˜ค์ง€ํ™˜
์—ญํ•  ํŒ€์žฅ
ํ”„๋ก ํŠธ์—”๋“œ
๋””์ž์ธ
ํ”„๋ก ํŠธ์—”๋“œ
ํ”„๋ก ํŠธ์—”๋“œ ํ”„๋ก ํŠธ์—”๋“œ ๋ฐฑ์—”๋“œ ๋ฐฑ์—”๋“œ
GitHub
์ด๋ฉ”์ผ

๐Ÿ“ ์ €์ž‘๊ถŒ ์ •๋ณด (Copyright)