1- # ๐ Handover - ๊ตญ๋ฐฉ์
๋ฌด๊ณต์ ์ฒด๊ณ
1+ # ๐ Handover - ๊ตญ๋ฐฉ์
๋ฌด๊ณต์ ์ฒด๊ณ
2+
23<p align =" center " >
34 <br >
45 <div width =" 400 " style =" background : #fff ;" align =" center " >
56 <img src =' ./image/logo.svg ' alt =" Handover Logo " width =" 400 " />
67 </div >
78</p >
89<p align =" center " >
9- <a href =" https://www.notion.so/osam-handover/f9e9132e0b0c4832a3d77e27411241e0?v=fe68ef0118be4d11aa0b1d0f6e8c20ea " >Documentation</a >  ;  ; |  ;  ; <a href =" " >PPT </a >  ;  ; |  ;  ; <a href =" " >Demo Video</a >
10+ <a href =" https://www.notion.so/osam-handover/f9e9132e0b0c4832a3d77e27411241e0?v=fe68ef0118be4d11aa0b1d0f6e8c20ea " >Documentation</a >  ;  ; |  ;  ; <a href =" bit.ly/osam-handover-presentation " >Presentation </a >  ;  ; |  ;  ; <a href =" " >Demo Video</a >
1011</p >
1112<p align =" center " >
1213 <img alt =" GitHub language count " src =" https://img.shields.io/github/contributors/osamhack2021/WEB_Handover_Handover?style=for-the-badge&logo " >
1718
1819## ๐ ํ๋ก์ ํธ ์๊ฐ (Project Introduction)
1920
20- ** Handover** ๋ ๊ตฐ ๋ด์ ์ธ์์ธ๊ณ๋ฅผ ํจ์จ์ ์ด๊ณ ํธ๋ฆฌํ๊ฒ ์งํํ ์ ์๋๋ก ๋๋ Web ์๋น์ค์
๋๋ค.
21-
22- > ** Handover** ๋ ๋ณด์ง ๋ณ๊ฒฝ ๋ฑ์ ์ํฉ์์ ํจ์จ์ ์ด๊ณ ์ ํํ์ง ์์ ์ธ์์ธ๊ณ๋ก ์ธํด<br >
23- > ** ์๋ก์ด ์
๋ฌด ํ๊ฒฝ์ ์ ์** ํ๋ ๊ฒ์ ์ด๋ ค์์ ๊ฒช๊ฑฐ๋ ** ์
๋ฌด์ ๊ณต๋ฐฑ** ์ด ์๊ธฐ๋ ๋ฌธ์ ์ ์ ํด๊ฒฐํ๊ณ ์ ํฉ๋๋ค.<br ><br >
24- > ๋ ๋์๊ฐ, ๋ถ๋ ๊ฐ ํจ์จ์ ์ธ ์
๋ฌด ๋ฐฉ๋ฒ์ ๊ณต์ ํ๋<br >
25- > ** ํตํฉ์ ์
๋ฌด ๊ณต์ ํ๋ซํผ** ์ ์ ๊ณตํ๋ ๊ฒ์ ๋ชฉํ๋ก ํ๊ณ ์์ต๋๋ค.<br >
21+ ** Handover** ๋ ๊ตฐ ๋ด์ ์ธ์์ธ๊ณ๋ฅผ ํจ์จ์ ์ด๊ณ ํธ๋ฆฌํ๊ฒ ์งํํ ์ ์๋๋ก ๋๋ Web ์๋น์ค์
๋๋ค.
2622
23+ > ** Handover** ๋ ๋ณด์ง ๋ณ๊ฒฝ ๋ฑ์ ์ํฉ์์ ํจ์จ์ ์ด๊ณ ์ ํํ์ง ์์ ์ธ์์ธ๊ณ๋ก ์ธํด
24+ >
25+ > ** ์๋ก์ด ์
๋ฌด ํ๊ฒฝ์ ์ ์** ํ๋ ๊ฒ์ ์ด๋ ค์์ ๊ฒช๊ฑฐ๋ ** ์
๋ฌด์ ๊ณต๋ฐฑ** ์ด ์๊ธฐ๋ ๋ฌธ์ ์ ์ ํด๊ฒฐํ๊ณ ์ ํฉ๋๋ค.
26+ >
27+ > ๋ ๋์๊ฐ, ๋ถ๋ ๊ฐ ํจ์จ์ ์ธ ์
๋ฌด ๋ฐฉ๋ฒ์ ๊ณต์ ํ๋
28+ >
29+ > ** ํตํฉ์ ์
๋ฌด ๊ณต์ ํ๋ซํผ** ์ ์ ๊ณตํ๋ ๊ฒ์ ๋ชฉํ๋ก ํ๊ณ ์์ต๋๋ค.
2730
2831## ๐ ๋ชฉ์ฐจ
32+
2933<ol >
3034 <li ><a href =" #features " >๊ธฐ๋ฅ ์ค๋ช
</a ></li >
3135 <li ><a href =" #prerequisites " >์ปดํจํฐ ๊ตฌ์ฑ / ํ์ ์กฐ๊ฑด ์๋ด</a ></li >
4347<h2 id =" features " > โจ ๊ธฐ๋ฅ ์ค๋ช
(Key Features) </h2 >
4448
4549Handover๋ง์ ** 3๊ฐ์ง ํต์ฌ ๊ธฐ๋ฅ** ๊ณผ ํจ๊ป ๋ ํธ๋ฆฌํ๊ณ ๋๋ํ ์ธ์์ธ๊ณ๋ฅผ ์งํํด๋ณด์ธ์!
46- - ** 3๋จ๊ณ ๋ฌธ์ ๊ตฌ์ฑ** ์ผ๋ก ** ์ฒด๊ณ์ ์ธ** ์ธ์์ธ๊ณ ๋ฌธ์
47- - ** ๊ทธ๋ฃน** , ** ๋ถ๋งํฌ** , ** ๋๊ธ** ๊ธฐ๋ฅ๋ค๋ก ** ๊ณต์ ํ๋** ์ธ์์ธ๊ณ ๋ฌธ์
48- - ** ๋ณด์ ๊ด๋ฆฌ์** ๊ธฐ๋ฅ์ผ๋ก ๋ณด์์๋ฐ์ผ๋ก๋ถํฐ ** ์์ ํ** ์ธ์์ธ๊ณ ๋ฌธ์
50+
51+ - ** 3๋จ๊ณ ๋ฌธ์ ๊ตฌ์ฑ** ์ผ๋ก ** ์ฒด๊ณ์ ์ธ** ์ธ์์ธ๊ณ ๋ฌธ์
52+ - ** ๊ทธ๋ฃน** , ** ๋ถ๋งํฌ** , ** ๋๊ธ** ๊ธฐ๋ฅ๋ค๋ก ** ๊ณต์ ํ๋** ์ธ์์ธ๊ณ ๋ฌธ์
53+ - ** ๋ณด์ ๊ด๋ฆฌ์** ๊ธฐ๋ฅ์ผ๋ก ๋ณด์์๋ฐ์ผ๋ก๋ถํฐ ** ์์ ํ** ์ธ์์ธ๊ณ ๋ฌธ์
4954
5055<h3 > ๐๏ธ 3๋จ๊ณ ๋ฌธ์ ๊ตฌ์ฑ </h3 >
5156
5257<p align =" center " >
53- <img src =' ./image/document_architecture.png ' width =" 500 " />
58+ <img src =' ./image/document_architecture.png ' width =" 80% " />
5459</p >
5560
56- Handover ๋ด์ ๋ชจ๋ ๋ฌธ์๋ ** ๐๏ธ์๋, ๐ฐ๋ฌธ์, ๐์นด๋** ์ 3๋จ๊ณ ๊ตฌ์ฑ์ ๊ฐ์ต๋๋ค.
61+ Handover ๋ด์ ๋ชจ๋ ๋ฌธ์๋ ** ๐๏ธ ์๋, ๐ฐ ๋ฌธ์, ๐ ์นด๋** ์ 3๋จ๊ณ ๊ตฌ์ฑ์ ๊ฐ์ต๋๋ค.
62+
5763- ** ์๋** : ๋ถ์ ๋๋ ๋ณด์ง์ ์ฐ๊ด๋ ** ๋ฌธ์๋ค์ ์งํฉ**
5864- ** ๋ฌธ์** : ํ๋์ ์
๋ฌด๋ฅผ ๊ตฌ์ฑํ๋ ** ์นด๋๋ค์ ์งํฉ**
5965- ** ์นด๋** : ์์ ์
๋ฌด๋ฅผ ์ํํ๋ ๋ฐฉ๋ฒ์ ์ค๋ช
ํ ** ์งง์ ๊ธ**
@@ -87,7 +93,7 @@ Handover ๋ด์ ๋ชจ๋ ๋ฌธ์๋ **๐๏ธ์๋, ๐ฐ๋ฌธ์, ๐์นด๋** ์ 3
8793| :---:| :---:| :---:| :---:|
8894| โ (84+)| โ (84+)| โ (63+)| โ (14.1+)|
8995
90- <h2 id =" expectation " > โจ Handover ๊ธฐ๋ํจ๊ณผ (Expectation) </h2 >
96+ <h2 id =" expectation " > โจ Handover ์ ๊ธฐ๋ํจ๊ณผ (Expectation) </h2 >
9197
9298 ### ๐ ์ธ์์ธ๊ณ ๋ฐฉ์์ ์ฒด๊ณํ
9399 - ๊ณตํต๋ ์ธ์์ธ๊ณ ๋ฌธ์ ์์ฑ ํ๋ซํผ์ ํตํ ** ์ธ์์ธ๊ณ ๋ฐฉ์ ํต์ผ**
@@ -99,7 +105,7 @@ Handover ๋ด์ ๋ชจ๋ ๋ฌธ์๋ **๐๏ธ์๋, ๐ฐ๋ฌธ์, ๐์นด๋** ์ 3
99105 - ์ฌ์ฉ์๋ค์ ** ์๊ฒฌ ๊ณต์ ** ๋ฅผ ํตํ ์
๋ฌด ํจ์จ์ฑ ์์น
100106 - ** ๋
ธํ์ฐ ๊ณต์ ** ๋ฅผ ํตํ ์
๋ฌด ๋ฅ๋ฅ ์ฆํญ
101107
102- <h2 id =" competitiveness " > ๐ฅ Handover๊ฐ ๊ฐ์ง ๊ฒฝ์๋ ฅ (Competitiveness) </h2 >
108+ <h2 id =" competitiveness " > ๐ฅ Handover ๊ฐ ๊ฐ์ง ๊ฒฝ์๋ ฅ (Competitiveness) </h2 >
103109
104110 ### ๐ ์ธ์์ธ๊ณ ๋ฌธ์์ ๋ฐ์ดํฐํ
105111 - ์ฌ์ฉ์๋ค์ ์
๋ฌด ์ํ ๋ฌธ์๋ค์ ๊ตญ๋ฐฉ๊ณผํ์ฐ๊ตฌ์, ๊ตญ๋ฐฉ์ ์ฑ
์ค ๋ฑ์ ๊ธฐ๊ด์์ ์ฐ๊ตฌ๋ฐ์ดํฐ๋ก ํ์ฉ ๊ฐ๋ฅ
@@ -117,58 +123,71 @@ Handover ๋ด์ ๋ชจ๋ ๋ฌธ์๋ **๐๏ธ์๋, ๐ฐ๋ฌธ์, ๐์นด๋** ์ 3
117123 - [ docker-compose] ( https://docs.docker.com/compose/ )
118124 - [ nginx] ( https://www.nginx.com/ )
119125
120- ### :shopping_cart : Back-end
121- - [ Node.js] ( https://nodejs.org/en/ )
122- - [ Express] ( https://expressjs.com/ )
123- - [ jsonwebtoken] ( https://github.com/auth0/node-jsonwebtoken )
124- - [ MongoDB] ( https://www.mongodb.com/ )
125- - [ Mongoose] ( https://mongoosejs.com/ )
126- - [ Algolia] ( https://www.algolia.com/ )
127-
128- ### ๐ Front-end
129- - [ React] ( https://reactjs.org/ )
130- - [ Redux] ( https://redux.js.org/ )
131- - [ MaterialUI] ( https://mui.com/ )
132- - [ Sass] ( https://sass-lang.com/ )
133- - [ webpack] ( https://webpack.kr/ )
134-
126+ ### :shopping_cart : Back-end
127+
128+ - [ Node.js] ( https://nodejs.org/en/ )
129+ - [ Express] ( https://expressjs.com/ )
130+ - [ jsonwebtoken] ( https://github.com/auth0/node-jsonwebtoken )
131+ - [ MongoDB] ( https://www.mongodb.com/ )
132+ - [ Mongoose] ( https://mongoosejs.com/ )
133+ - [ Algolia] ( https://www.algolia.com/ )
134+
135+ ### ๐ Front-end
136+
137+ - [ React] ( https://reactjs.org/ )
138+ - [ Redux] ( https://redux.js.org/ )
139+ - [ MaterialUI] ( https://mui.com/ )
140+ - [ Sass] ( https://sass-lang.com/ )
141+ - [ webpack] ( https://webpack.kr/ )
142+
135143<h2 id =" install " > ๐ ์ค์น ์๋ด (Installaltion Methods) </h2 >
136144
137- ### 1. Docker ์ค์
138- ์ฌ์ฉํ๋ ์ด์์ฒด์ ์ ๋ง๋ [ Docker ์ค์น] ( https://docs.docker.com/get-docker/ )
139- ### 2. Clone Repository
140- ```
141- git clone https://github.com/osamhack2021/Web_Handover_Handover.git handover && cd handover
142- ```
143-
144- ### 3. Docker ์คํ
145- ```
146- npm run prd
147- ```
148- ### 4. ํ๋ก์ ํธ ์คํ ํ์ธ
149- [ localhost] ( http://localhost ) ์์ ์๋น์ค๋๊ณ ์๋ Handover ํ์ธ
150- ### 4. Docker ์ค์ง
151- ```
152- npm down
153- ```
145+ ### 1. Repository Clone
146+
147+ ํฐ๋ฏธ๋(๋๋ ์ฝ์)์์ ๋ค์ ๋ช
๋ น์ด ์คํ
148+
149+ ```
150+ git clone https://github.com/osamhack2021/Web_Handover_Handover.git handover && cd handover
151+ ```
152+ ### 2. Docker ์ค์
153+
154+ ์ฌ์ฉํ๋ ์ด์์ฒด์ ์ ๋ง๋ [ Docker ์ค์น] ( https://docs.docker.com/get-docker/ )
154155
155156
157+ ### 3. Docker ์คํ
158+
159+ ํ๋ก์ ํธ root ํด๋์์ ํฐ๋ฏธ๋์ ์ด๊ณ ๋ค์ ๋ช
๋ น์ด ์คํ
160+ ```
161+ npm run prd
162+ ```
163+
164+ ### 4. ํ๋ก์ ํธ ์คํ ํ์ธ
165+
166+ [ localhost] ( http://localhost ) ์์ ์๋น์ค๋๊ณ ์๋ Handover ํ์ธ
167+
168+ ### 4. Docker ์ค์ง
169+
170+ ` Ctrl + C ` ๋ฅผ ๋๋ฌ์ ํฐ๋ฏธ๋์์ ์คํ๋๋ Docker ์ค์ง
171+
156172<h2 id =" gettingstarted " > ๐ ํ๋ก์ ํธ ์ฌ์ฉ๋ฒ (Getting Started) </h2 >
157173
158174- yet to do...
159-
175+
160176<h2 id =" contribute " > ๐ Handover์ ๊ธฐ์ฌํ๋ ๋ฒ (How to contribute) </h2 >
161177
162- Handover๋ ** ์คํ์์ค ํ๋ก์ ํธ** ๋ก, ์ฌ๋ฌ๋ถ๋ค์ ๋์์ ๊ธฐ๋ค๋ฆฌ๊ณ ์์ต๋๋ค.
163- Handover์ ๊ธฐ์ฌํ๊ณ ์ถ์ผ์๋ค๋ฉด, ** [ Contributing.md] ( Contributing.md ) ** ์ ์ฐธ๊ณ ํด์ฃผ์ธ์.
178+ Handover๋ ** ์คํ์์ค ํ๋ก์ ํธ** ๋ก, ์ฌ๋ฌ๋ถ๋ค์ ๋์์ ๊ธฐ๋ค๋ฆฌ๊ณ ์์ต๋๋ค.
179+ Handover์ ๊ธฐ์ฌํ๊ณ ์ถ์ผ์๋ค๋ฉด, ** [ Contributing.md] ( Contributing.md ) ** ์ ์ฐธ๊ณ ํด์ฃผ์ธ์.
164180
165181<h2 id =" structure " > ๐น๏ธ ์์ค์ฝ๋ ๊ตฌ์กฐ (Source Code Structure) </h2 >
166182
167183### WEB(FE)
184+
168185` /frontend `
186+
169187### WEB(BE)
188+
170189` /backend `
171-
190+
172191<h2 id =" teaminfo " > ๐จโ๐ฆโ๐ฆ ํ ์ ๋ณด (Team Info) </h2 >
173192
174193<table width =" 950 " >
@@ -312,4 +331,3 @@ Handover์ ๊ธฐ์ฌํ๊ณ ์ถ์ผ์๋ค๋ฉด, **[Contributing.md](Contributing.md)**
312331<h2 id =" license " > ๐ ์ ์๊ถ ๋ฐ ์ฌ์ฉ๊ถ ์ ๋ณด (Copyright / End User License) </h2 >
313332
314333 - [ ** MIT License** ] ( ./LICENSE )
315-
0 commit comments