diff --git a/README.md b/README.md index 0f9af3e2..f85c5a5e 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,113 @@ -

๐Ÿฅฅ Cocode  ๐Ÿฅฅ

-

- Version - - Documentation - +

+ ์ฝ”์ฝ”๋“œ

-## Command +
+--- + + + + Documentation + + + + issue tracking + + + + pr tracking + + + + pr tracking + + +
+
-- clone์„ ๋ฐ›์€ ํ›„ ์ž์‹ ์˜ ๋กœ์ปฌํ™˜๊ฒฝ์—์„œ ๊ฐœ๋ณ„ service project์— ๋Œ€ํ•œ ๊ฐœ๋ฐœ์„ ์‹œ์ž‘ -- ๊ฐœ๋ณ„ service project์˜ root directory์—์„œ `npm install` ์‹คํ–‰ +## :house_with_garden: Home page +http://www.cocode.site
-- ๊ฐœ๋ฐœ container๋“ค์„ ์‹คํ–‰์‹œํ‚ค๋Š” docker-compose ๋ช…๋ น์–ด +## ๐Ÿ“Œ ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ +> Cocode๋Š” ์›น ํ†ตํ•ฉ๊ฐœ๋ฐœํ™˜๊ฒฝ ์„œ๋น„์Šค๋ฅผ ์ œ๊ณตํ•˜๋Š” CodeSandbox๋ฅผ cloneํ•˜๋Š” ํ”„๋กœ์ ํŠธ์ž…๋‹ˆ๋‹ค! + +### ๋ช‡๋ฒˆ์˜ ํด๋ฆญ๋งŒ์œผ๋กœ ๊ฐ„ํŽธํ•˜๊ณ  ๋น ๋ฅด๊ฒŒ React ํ”„๋กœ์ ํŠธ๋ฅผ ์ƒ์„ฑํ•ด๋ณด์„ธ์š”! +์‹ค์‹œ๊ฐ„์œผ๋กœ ๋ธŒ๋ผ์šฐ์ € ์œ„์—์„œ ํ”„๋กœ์ ํŠธ ๋นŒ๋“œ ๊ฒฐ๊ณผ๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. +๋ผ์ด๋ธŒ ๊ธฐ๋Šฅ์„ ์ด์šฉํ•˜๋ฉด ๋‹ค๋ฅธ ์‚ฌ์šฉ์ž์™€ ๊ฐ™์€ ํ”„๋กœ์ ํŠธ๋ฅผ ๋™์‹œ์— ํŽธ์ง‘ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. + +
+ +## ๐Ÿ“Œ ์„œ๋น„์Šค ๊ตฌ์„ฑ +```bash +๐Ÿฅฅ cocode # ์ „์ฒด service๋ฅผ ์ œ๊ณตํ•˜๋Š” client +๐Ÿฅฅ coconut # client side build ๊ธฐ๋Šฅ์„ ์ˆ˜ํ–‰ํ•˜๋Š” client +๐Ÿฅฅ api-server # API server +๐Ÿฅฅ live-server # ๋ผ์ด๋ธŒ ๊ธฐ๋Šฅ ์ œ๊ณต server ``` +
-// ์ด๋ฏธ์ง€๋ฅผ ๋‹ค์‹œ ๋นŒ๋“œํ•˜๊ณ  ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰ +## ๐Ÿ“Œ ํ”„๋กœ์ ํŠธ ์‹œ์ž‘ํ•˜๊ธฐ +> ๊ฐ ๋””๋ ‰ํ† ๋ฆฌ ๋ณ„๋กœ .env ํŒŒ์ผ์„ ์ž‘์„ฑํ•˜๊ณ  ์‹œ์ž‘ํ•˜์…”์•ผ ๋ฉ๋‹ˆ๋‹ค. +> dev.env๋ฅผ ์ฐธ๊ณ ํ•ด์ฃผ์„ธ์š”! + +### ๐Ÿณ docker-compose๋กœ ํ•œ๋ฒˆ์— ์‹œ์ž‘ +```bash +# ์ด๋ฏธ์ง€๋ฅผ ๋‹ค์‹œ ๋นŒ๋“œํ•˜๊ณ  ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰ docker-compose up --build -// ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰ +# ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰ docker-compose up -// ๋ฐฑ๊ทธ๋ผ์šด๋“œ๋กœ ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰ +# ๋ฐฑ๊ทธ๋ผ์šด๋“œ๋กœ ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰ docker-compose up -d -// ์ปจํ…Œ์ด๋„ˆ ๋„๊ธฐ +# ์ปจํ…Œ์ด๋„ˆ ๋„๊ธฐ docker-compose down ``` + +### ๐Ÿ• cocode client +``` +cd cocode +yarn +yarn start +``` + +### ๐Ÿˆ api server +``` +cd api-server +npm install +npm run dev +``` + +
+
+ +## ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ ๋ฉค๋ฒ„์†Œ๊ฐœ(์ˆœ์„œ๋Œ€๋กœ) +

+ ์ž˜ํ•ด์ž˜ํ•ด +

+ +
+ +### ๐Ÿ‘ฉโ€ ๊น€ํฌ๋ผ [@lallaheeee](https://github.com/lallaheeee) +> ํผํผ... ๊ธ์ ๊ธ์ ... + +**์Šคํ‹ฐ๋ธŒ ํฌ๋ผ** + +### ๐Ÿ‘จโ€ ๊น€์ค€ํ‘œ [@BasilToast](https://github.com/BasilToast) +> ๋ถˆ-ํŽธํ•˜๋„ค์š”. + +**๋ถˆํŽธํ•œ ์–‘ํ‰์‚ฌ๋žŒ** + +### ๐Ÿ‘งโ€ ์šฐํ˜œ์ฃผ [@hzoou](https://github.com/hzoou) +> ๋Œ€์ถฉ? ์ธ๊ฐ„์—๊ฒŒ ๊ฐ€์žฅ ํ•ด๋กœ์šด ๋ฒŒ๋ ˆ๊ฐ€ *๋Œ€์ถฉ* ์ด์—์š”. + +**์šฐ๋ฆฌ ํ”„๋กœ์ ํŠธ์˜ ๋น„์„ ์‹ค์„ธ!** + +### ๐Ÿ‘ฆ ์œก์ง€์ˆ˜ [@yukjisoo](https://github.com/yukjisoo) +> ํ˜‘์—…์ด ์žฅ๋‚œ์ด์—์š”? + +**๊ณ ์ถ”์ฐ๊ธฐ๋Œ€ํ™ฐ**