diff --git a/README.md b/README.md index 4491d02..93e36bb 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,165 @@ -# Officener Sixsense Client ver. +# ๐Ÿข ์˜คํ”ผ์Šค๋„ˆ (officener) -## ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜ ๋ชฉ๋ก :) +> ์ž…์ฃผ ๊ฒฝํ—˜์€ ๋†’์ด๊ณ , ๊ด€๋ฆฌ ์†Œ์š”๋Š” ๋‚ฎ์ถ”๊ณ 
+> ์Šค๋งˆํŠธ ์˜คํ”ผ์Šค ๋นŒ๋”ฉ ํ†ตํ•ฉ ํ”Œ๋žซํผ ์˜คํ”ผ์Šค๋„ˆ! -- feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•œ ๊ฒฝ์šฐ -- fix: ์—๋Ÿฌ๋ฅผ ์ˆ˜์ •ํ•œ ๊ฒฝ์šฐ -- design: CSS ๋“ฑ UI ๋””์ž์ธ์„ ๋ณ€๊ฒฝํ•œ ๊ฒฝ์šฐ -- BREAKING: CHANGE ์ค‘๋Œ€ํ•œ API๋ฅผ ๋ณ€๊ฒฝํ•œ ๊ฒฝ์šฐ -- HOTFIX: ๊ธ‰ํ•˜๊ฒŒ ์น˜๋ช…์ ์ธ ์—๋Ÿฌ๋ฅผ ๊ณ ์นœ ๊ฒฝ์šฐ -- style: ์ฝ”๋“œ ํฌ๋งท ๋ณ€๊ฒฝ์„ ํ•˜๊ฑฐ๋‚˜ ์„ธ๋ฏธ ์ฝœ๋ก  ๋ˆ„๋ฝํ•˜์—ฌ ์ถ”๊ฐ€ํ•˜๋ฉด์„œ ์ฝ”๋“œ ์ˆ˜์ •์ด ์—†๋Š” ๊ฒฝ์šฐ -- refactor: ์ฝ”๋“œ๋ฅผ ๋ฆฌํŒฉํ† ๋งํ•œ ๊ฒฝ์šฐ -- comment: ์ฃผ์„์„ ์ถ”๊ฐ€ํ•˜๊ฑฐ๋‚˜ ๋ณ€๊ฒฝํ•œ ๊ฒฝ์šฐ -- docs: ๋ฌธ์„œ๋ฅผ ์ˆ˜์ •ํ•œ ๊ฒฝ์šฐ -- test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๋ฅผ ์ถ”๊ฐ€, ๋ณ€๊ฒฝ, ๋ฆฌํŒฉํ† ๋งํ•œ ๊ฒฝ์šฐ -- chore: ๊ธฐํƒ€ ๋ณ€๊ฒฝ์‚ฌํ•ญ (๋นŒ๋“œ ์Šคํฌ๋ฆฝํŠธ ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ง• ์„ค์ • ๋“ฑ) -- rename: ํŒŒ์ผ or ํด๋”๋ช… ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ๊ฒฝ์šฐ -- remove: ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ +
-### ํŒ€ ์‹์Šค์„ผ์Šค ์ฝ”๋“œ ์ปจ๋ฒค์…˜ +### ๐Ÿ–ฅ [ํด๋ผ์ด์–ธํŠธ DEMO](https://officener.vercel.app/) -### ์—์–ด๋น„์—”๋น„ ์ฝ”๋“œ ์ปจ๋ฒค์…˜ ๋งํฌ +### [โš™๏ธ ์–ด๋“œ๋ฏผ DEMO](https://officener-admin.vercel.app/) -[์—์–ด๋น„์—”๋น„](https://github.com/tipjs/javascript-style-guide) +
+ +## ๐Ÿ—“๏ธ ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ + +> **์ฃผ ์ œ** : ๋นŒ๋”ฉ ๋‚ด ์ž…์ฃผ์ž ํ™œ์„ฑํ™”๋ฅผ ์œ„ํ•œ ์„œ๋น„์Šค ๊ธฐํš/๊ฐœ๋ฐœ
> **๋ชฉ ํ‘œ** : ์œ ์ € ๊ทธ๋กœ์Šค ๊ธฐํš/๊ฐœ๋ฐœ์„ ํ†ตํ•ด ํ•ต์‹ฌ ์ง€ํ‘œ์ธ '์œ ์ € ๊ฐ€์ž…์ž ์ˆ˜'์™€ 'WAU' ๋†’์ด๊ธฐ
> **๊ฐœ๋ฐœ ๊ธฐ๊ฐ„** : 2023. 08. 16 ~ 2023. 10. 06 (2๊ฐœ์›”)
+ +
+ +## ๐Ÿ‘ค ํ”„๋กœ์ ํŠธ ํŒ€์› + +| ๊น€์ค€ํฌ | ๊น€์ง„์šฐ | ์ด์‹œ์šฐ | ์œ ํฌํƒœ (ํŒ€์žฅ) | ์กฐ์€์ƒ | +| :-----------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | +| ๊น€์ค€ํฌ | ๊น€์ง„์šฐ | ์ด์‹œ์šฐ | ์œ ํฌํƒœ | ์กฐ์€์ƒ | +| ์ดˆ๋Œ€์žฅ ์ƒ์„ฑ | ์ดˆ๋Œ€์žฅ ๋ทฐ
๊ด€๋ฆฌ์ž | ์ดˆ๋Œ€์žฅ ์ˆ˜์ •
์ดˆ๋Œ€์žฅ ๋ทฐ | ํ™ˆ ๋ฆฌ๋””์ž์ธ
์˜ค๋Š˜ ์ ์‹ฌ | ์˜ค๋Š˜์ ์‹ฌ | + +
+ +## ๐Ÿ› ๏ธ๏ธ ์‚ฌ์šฉ๊ธฐ์ˆ  ๋ฐ ๊ฐœ๋ฐœํ™˜๊ฒฝ + +**Front-End** + +

+ + + + + + + +

+ +**Back-End** + +

+ + + + + + + + +

+ +**Deployment** + +

+ + + +

+ +**Cowork Tools** + +

+ + + + + +

+ +

+ +## ๐Ÿ–ฅ๏ธ ๊ธฐ๋Šฅ ์†Œ๊ฐœ + +### 1. ๋ฐฉ๋ฌธ์ž ์ดˆ๋Œ€์žฅ + +- ๋ฐฉ๋ฌธ์ž ์ดˆ๋Œ€ํ•˜๊ธฐ +- ์ดˆ๋Œ€์žฅ ๋ชฉ๋ก ํ™•์ธ +- ์ดˆ๋Œ€์žฅ ์ˆ˜์ •/์‚ญ์ œ +- ์‹ค๋‚ด ์ง€๋„ ํ™•์ธ +- ๋ฐฉ๋ฌธํ•  ๋นŒ๋”ฉ ๊ทผ์ฒ˜ ์‹œ์„ค ์•ˆ๋‚ด +- ๋ฐฉ๋ฌธ์ฆ ์•Œ๋ฆผํ†ก +- ๋ฐฉ๋ฌธ์ž ๊ด€๋ฆฌ ์›น + +
+ +### 2. ์ฃผ์ฐจ ์ •์‚ฐ + +- ๋ฐฉ๋ฌธ ์ฃผ์ฐจ ๋“ฑ๋ก +- ์ฃผ์ฐจ ๊ฒฐ์ œ (์ค€๋น„ ์ค‘) +- ์ฃผ์ฐจ ํ• ์ธ ์ ์šฉ (์ค€๋น„ ์ค‘) +- ์ฃผ์ฐจ ์‚ฌ์ „ ์ •์‚ฐ (์ค€๋น„ ์ค‘) + +
+ +### 3. ์˜ค๋Š˜ ์ ์‹ฌ + +- ๋ฉ”๋‰ด ๋žญํ‚น +- ๋ฉ”๋‰ด ๋žญํ‚น๋ณ„ ๋ฆฌ๋ทฐ +- ์ ์‹ฌ ๋ฉ”๋‰ด ์ถ”์ฒœ ๋ฃฐ๋ › +- ๋ฃฐ๋ › ๊ฒฐ๊ณผ ๋ฉ”๋‰ด ๋ฆฌ๋ทฐ ํ™•์ธ +- ๋ฆฌ๋ทฐ ์ž‘์„ฑ +- ๋‚˜๋งŒ์˜ ์ ์‹ฌ ๋‹ฌ๋ ฅ ๋งŒ๋“ค๊ธฐ + +
+ +### 4. ๊ธฐํƒ€ + +- ํ™ˆ ํ™”๋ฉด ๋ฆฌ๋””์ž์ธ +- ๋งˆ์ด ํŽ˜์ด์ง€ ๋ฆฌ๋””์ž์ธ +- ํฌ์ธํŠธ ์ง€๋„ +- ํฌ์ธํŠธ ํ™œ์šฉ (์ค€๋น„ ์ค‘) + +
+ +| ํ™ˆ ๋ฆฌ๋””์ž์ธ | ๋งˆ์ดํŽ˜์ด์ง€ ๋ฆฌ๋””์ž์ธ | +| :---------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------: | +| | | +| ๋ฐฉ๋ฌธ์ž ์ดˆ๋Œ€์žฅ ์ƒ์„ฑ | ๋ฐฉ๋ฌธ์ž ์ดˆ๋Œ€์žฅ ๋ทฐ | +| | | +| ์ดˆ๋Œ€์žฅ ๋ฆฌ์ŠคํŠธ | ๋นŒ๋”ฉ ์ •๋ณด | +| | | +| ์ดˆ๋Œ€ ์žฅ์†Œ ํ™•์ธ | ์ฃผ์ฐจ ๋“ฑ๋ก | +| | | +| ์˜ค๋Š˜ ์ ์‹ฌ ๋ฃฐ๋ › | ์˜ค๋Š˜ ์ ์‹ฌ ๋ฉ”์ธ | +| | | +| ์˜ค๋Š˜ ์ ์‹ฌ ๋ฆฌ๋ทฐ ์ž‘์„ฑ | ์˜ค๋Š˜ ์ ์‹ฌ ๋ฆฌ๋ทฐ ์ž‘์„ฑ | +| | | +| ์˜ค๋Š˜ ์ ์‹ฌ ๋‹ฌ๋ ฅ | ์˜ค๋Š˜ ์ ์‹ฌ ๋žญํ‚น๋ณ„ ๋ฆฌ๋ทฐ | +| | | + +

+ +## ๐Ÿ’ป ํ”„๋กœ์ ํŠธ ํ…Œ์ŠคํŠธ + +### clone project + +```bash +$ git@github.com:livable-final/client.git +$ git@github.com:livable-final/admin.git +``` + +### go to project + +```bash +$ cd client +$ cd admin +``` + +### install npm + +```bash +$ npm install +``` + +### start project + +```bash +$ npm run dev +``` + +