diff --git a/README.md b/README.md index 222b1658..04f04af8 100644 --- a/README.md +++ b/README.md @@ -1 +1,191 @@ -Coworkers +# ๐Ÿ’Ž Coworkers ๐Ÿ’Ž + + +๋žœ๋”ฉํŽ˜์ด์ง€ ์ด๋ฏธ์ง€ (์ถ”๊ฐ€ ์˜ˆ์ •) + + +

+ ๐Ÿš€ ์„œ๋น„์Šค ๋ฐ”๋กœ๊ฐ€๊ธฐ +

+ +
+ +## ๐Ÿ“ ์†Œ๊ฐœ + +>Coworkers๋Š” ์—ฌ๋Ÿฌ ๋ช…์ด ํ•˜๋‚˜์˜ ๊ทธ๋ฃน์„ ๋งŒ๋“ค์–ด +ํ•  ์ผ(Task)์„ ํ•จ๊ป˜ ๊ณต์œ ํ•˜๊ณ  ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ๋Š” ํ˜‘์—…์šฉ To-do ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค. + +
+ +## ๐ŸŽฏ ๋ชฉ์  + +>ํŒ€ ๋‹จ์œ„๋กœ ํ•  ์ผ์„ ์ •๋ฆฌํ•˜๊ณ  ์ง„ํ–‰ ์ƒํ™ฉ์„ ํˆฌ๋ช…ํ•˜๊ฒŒ ๊ณต์œ ํ•˜์—ฌ, +ํ˜‘์—… ํšจ์œจ์„ ๋†’์ด๋Š” ๊ฒƒ์ด Coworkers์˜ ํ•ต์‹ฌ ๋ชฉ์ ์ž…๋‹ˆ๋‹ค. + +
+ + +## โœจ์ฃผ์š” ๊ธฐ๋Šฅ + +|ํŒ€ ํŽ˜์ด์ง€| +|:---:| +|| +|ํŒ€์˜ ์ „์ฒด์ ์ธ ์ง„ํ–‰ ํ˜„ํ™ฉ๊ณผ ๋ฉค๋ฒ„ ์ •๋ณด๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ๋Š” ํŒ€ ์š”์•ฝ ํ™”๋ฉด| + + +|ํ•  ์ผ ๊ด€๋ฆฌ| +|:---:| +|| +|๋‚ ์งœ๋ณ„ ํ•  ์ผ์„ ํ™•์ธํ•˜๊ณ , ์ƒ์„ธ ๋ณด๊ธฐ ๋ฐ ์™„๋ฃŒ ์ฒดํฌ๋ฅผ ํ•  ์ˆ˜ ์žˆ๋Š” ํ™”๋ฉด| + + +|์ž์œ ๊ฒŒ์‹œํŒ| +|:---:| +|| +|์ž์œ ๋กญ๊ฒŒ ์†Œํ†ตํ•˜๊ณ  ์ •๋ณด๋ฅผ ๊ณต์œ ํ•  ์ˆ˜ ์žˆ๋Š” ์ปค๋ฎค๋‹ˆํ‹ฐ ๊ณต๊ฐ„| + +
+ +
+ +## ๐Ÿงฐ ๊ธฐ์ˆ  ์Šคํƒ + +### ๐Ÿงฉ ํ”„๋ก ํŠธ์—”๋“œ + +### ๐Ÿ›  ์ฝ”๋“œ ํฌ๋งคํ„ฐ ๋ฐ ๊ฒ€์‚ฌ ๋„๊ตฌ + +### ๐Ÿค ํ˜‘์—… ๋„๊ตฌ + +### ๐Ÿš€ ๋ฐฐํฌ ํ”Œ๋žซํผ + + +
+ +## ๐Ÿ“ ํด๋” ๊ตฌ์กฐ +``` +src/ +โ”œโ”€โ”€ app/ # Next.js App Router ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€ +โ”œโ”€โ”€ api/ # ์„œ๋ฒ„ API ์š”์ฒญ ๋ชจ๋“ˆ (๋„๋ฉ”์ธ๋ณ„ CRUD) +โ”œโ”€โ”€ components/ # ์žฌ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ๊ณตํ†ต UI ์ปดํฌ๋„ŒํŠธ +โ”œโ”€โ”€ hooks/ # ์ปค์Šคํ…€ ํ›… (API ํ›… ํฌํ•จ) +โ”œโ”€โ”€ assets/ # ์•„์ด์ฝ˜ ๋ฐ ์ด๋ฏธ์ง€ ๋ฆฌ์†Œ์Šค +โ”œโ”€โ”€ constants/ # ์ƒ์ˆ˜ ๊ฐ’ ๋ฐ ๊ณตํ†ต ์„ค์ • +โ”œโ”€โ”€ types/ # TypeScript ํƒ€์ž… ์ •์˜ +โ””โ”€โ”€ utils/ # ๊ณตํ†ต ์œ ํ‹ธ ํ•จ์ˆ˜ +``` + +
+ +## ๐Ÿš€ ์‹คํ–‰ ๋ฐฉ๋ฒ• +``` +# 1. ์ €์žฅ์†Œ ํด๋ก  +git clone https://github.com/Part-4-1/coworkers.git + +# 2. ํด๋” ์ด๋™ +cd coworkers + +# 3. ํŒจํ‚ค์ง€ ์„ค์น˜ +npm install + +# 4. ๊ฐœ๋ฐœ ์„œ๋ฒ„ ์‹คํ–‰ +npm run dev +``` + +
+ +## ๐Ÿ” ํ™˜๊ฒฝ ๋ณ€์ˆ˜ +``` +NEXT_PUBLIC_API_URL=์„œ๋ฒ„_API_๋ฒ ์ด์Šค_URL +NEXT_PUBLIC_KAKAO_REST_API_KEY=์นด์นด์˜ค_REST_API_ํ‚ค +NEXT_PUBLIC_REDIRECT_URI=์นด์นด์˜ค_OAuth_๋ฆฌ๋‹ค์ด๋ ‰ํŠธ_URL(๋กœ์ปฌ) +NEXT_PUBLIC_KAKAO_REDIRECT_URI=์นด์นด์˜ค_OAuth_๋ฆฌ๋‹ค์ด๋ ‰ํŠธ_URL +``` + +
+ +
+ +## ๐Ÿ“Œ ๋ฐ์ผ๋ฆฌ ํŒ€ ์Šคํฌ๋Ÿผ +> ํšจ๊ณผ์ ์ธ ํ˜‘์—…์„ ์œ„ํ•ด ๋งค์ผ ์Šคํฌ๋Ÿผ์„ ์ง„ํ–‰ํ•˜๋ฉฐ, ๊ณต์œ ๋œ ๋‚ด์šฉ์€ ๋…ธ์…˜ ๋ฌธ์„œ๋กœ ์ฒด๊ณ„์ ์œผ๋กœ ๊ธฐ๋กํ•ฉ๋‹ˆ๋‹ค. + +#### ๐Ÿ—“๏ธ ์‹œ๊ฐ„ํ‘œ + +| ์š”์ผ | ์‹œ๊ฐ„ | +| :-------------: | :-------: | +| ํ™”์š”์ผ | **13:00** | +| ์›”ยท์ˆ˜ยท๋ชฉยท๊ธˆยทํ†  | **13:30** | + +
+ +## ๐Ÿ‘ฅ ํŒ€์› ์†Œ๊ฐœ + + + + + + + + + + + + + + + + + + +
+ +
+ ํ™ฉํœ˜ํƒœ (ํŒ€์žฅ) +
+
    +
  • ๋‹ด๋‹น ์ž‘์—… 1
  • +
  • ๋‹ด๋‹น ์ž‘์—… 2
  • +
  • ๋‹ด๋‹น ์ž‘์—… 3
  • +
+
+ +
+ ๊น€์ค€์—ด +
+
    +
  • ๋‹ด๋‹น ์ž‘์—… 1
  • +
  • ๋‹ด๋‹น ์ž‘์—… 2
  • +
  • ๋‹ด๋‹น ์ž‘์—… 3
  • +
+
+ +
+ ๊น€์ง„ํ˜ +
+
    +
  • ๋‹ด๋‹น ์ž‘์—… 1
  • +
  • ๋‹ด๋‹น ์ž‘์—… 2
  • +
  • ๋‹ด๋‹น ์ž‘์—… 3
  • +
+
+ +
+ ์ •์ฒ ์ข… +
+
    +
  • ๋‹ด๋‹น ์ž‘์—… 1
  • +
  • ๋‹ด๋‹น ์ž‘์—… 2
  • +
  • ๋‹ด๋‹น ์ž‘์—… 3
  • +
+
+ +
+ ํ•œ์žฅํฌ +
+
    +
  • ๋‹ด๋‹น ์ž‘์—… 1
  • +
  • ๋‹ด๋‹น ์ž‘์—… 2
  • +
  • ๋‹ด๋‹น ์ž‘์—… 3
  • +
+
+ +