Skip to content

Commit a00dbe0

Browse files
committed
Docs: Update README.md
1 parent bde8ca2 commit a00dbe0

1 file changed

Lines changed: 70 additions & 52 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 70 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
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>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="">PPT</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="">Demo Video</a>
10+
<a href="https://www.notion.so/osam-handover/f9e9132e0b0c4832a3d77e27411241e0?v=fe68ef0118be4d11aa0b1d0f6e8c20ea">Documentation</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="bit.ly/osam-handover-presentation">Presentation</a>&nbsp;&nbsp;|&nbsp;&nbsp;<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">
@@ -17,15 +18,18 @@
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>
@@ -43,17 +47,19 @@
4347
<h2 id="features"> โœจ ๊ธฐ๋Šฅ ์„ค๋ช… (Key Features) </h2>
4448

4549
Handover๋งŒ์˜ **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

Comments
ย (0)