Skip to content

Commit ed9df4d

Browse files
authored
Docs: Add feature part to README
Added feature part to README (work in progress)
1 parent c34ad75 commit ed9df4d

1 file changed

Lines changed: 52 additions & 31 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 52 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,53 +6,75 @@
66
## ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ
77
**Handover**๋Š” ๋” ํŽธ๋ฆฌํ•˜๊ณ  ๋˜‘๋˜‘ํ•œ ์ธ์ˆ˜์ธ๊ณ„๋ฅผ ์œ„ํ•œ ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค.
88

9-
## ๋ชฉ์ฐจ
10-
<ol>
11-
<li><a href="#features">๊ธฐ๋Šฅ ์„ค๋ช…</a></li>
12-
<li><a href="#prerequisites">์ปดํ“จํ„ฐ ๊ตฌ์„ฑ / ํ•„์ˆ˜ ์กฐ๊ฑด ์•ˆ๋‚ด</a></li>
13-
<li><a href="#stacks">๊ธฐ์ˆ  ์Šคํƒ</a></li>
14-
<li><a href="#install">์„ค์น˜ ์•ˆ๋‚ด</a></li>
15-
<li><a href="#gettingstarted">ํ”„๋กœ์ ํŠธ ์‚ฌ์šฉ๋ฒ•</a></li>
16-
<li><a href="#teaminfo">ํŒ€ ์ •๋ณด</a></li>
17-
<li><a href="#license">์ €์ž‘๊ถŒ ๋ฐ ์‚ฌ์šฉ๊ถŒ ์ •๋ณด</a></li>
18-
</ol>
199

20-
<h2 id="features"> ๊ธฐ๋Šฅ ์„ค๋ช… (Key Features) </h2>
10+
## ๊ธฐ๋Šฅ ์„ค๋ช… โœจ
11+
Handover๋งŒ์˜ **3๊ฐ€์ง€ ํ•ต์‹ฌ ๊ธฐ๋Šฅ**๊ณผ ํ•จ๊ป˜ ๋” ํŽธ๋ฆฌํ•˜๊ณ  ๋˜‘๋˜‘ํ•œ ์ธ์ˆ˜์ธ๊ณ„๋ฅผ ์ง„ํ–‰ํ•ด๋ณด์„ธ์š”!
12+
- **`3๋‹จ๊ณ„ ๋ฌธ์„œ ๊ตฌ์„ฑ`**(์„œ๋ž ๐Ÿ—„๏ธ, ๋ฌธ์„œ ๐Ÿ“ฐ, ์นด๋“œ ๐Ÿ“‡)์œผ๋กœ **์‰ฝ๊ฒŒ ์ฝ๊ณ , ์ž‘์„ฑํ•˜๋Š”** ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
13+
- **`๊ทธ๋ฃน ์ƒ์„ฑ`**, **`๋ถ๋งˆํฌ`**, **`๋Œ“๊ธ€`** ๊ธฐ๋Šฅ๋“ค๋กœ **ํ•จ๊ป˜ ๊ณต์œ ํ•˜๋Š”** ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
14+
- **`๋ณด์•ˆ ๊ด€๋ฆฌ์ž ๊ธฐ๋Šฅ`** ์œผ๋กœ ๋ณด์•ˆ์œ„๋ฐ˜์œผ๋กœ๋ถ€ํ„ฐ **์•ˆ์ „ํ•œ** ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
2115

22-
- 3๋‹จ๊ณ„ ๋ฌธ์„œ(์„œ๋ž ๐Ÿ—„๏ธ, ๋ฌธ์„œ ๐Ÿ“ฐ, ์นด๋“œ ๐Ÿ“‡) ๊ตฌ์„ฑ์œผ๋กœ ์‰ฝ๊ฒŒ ๊ด€๋ฆฌํ•˜๋Š” ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
23-
- ๊ทธ๋ฃน ์ƒ์„ฑ, ๋ถ๋งˆํฌ, ๋Œ“๊ธ€ ๊ธฐ๋Šฅ๋“ค๋กœ ํ•จ๊ป˜ ๊ณต์œ ํ•˜๋Š” ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
24-
- ๊ด€๋ฆฌ์ž ๊ธฐ๋Šฅ์œผ๋กœ ๋ณด์•ˆ์œ„๋ฐ˜์œผ๋กœ๋ถ€ํ„ฐ ์•ˆ์ „ํ•œ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
16+
<h3> 3๋‹จ๊ณ„ ๋ฌธ์„œ ๊ตฌ์„ฑ ๐Ÿ“‹</h3>
2517

26-
<h2 id="prerequisites"> ์ปดํ“จํ„ฐ ๊ตฌ์„ฑ / ํ•„์ˆ˜ ์กฐ๊ฑด ์•ˆ๋‚ด (Prerequisites)</h2>
18+
<p align="center">
19+
<img src='http://drive.google.com/uc?export=view&id=1uoMROdL5DH_qtouCaIKYWde_3wmi9pKq' width="800" height="500"/>
20+
</p>
2721

22+
Handover ๋‚ด์˜ ๋ชจ๋“  ๋ฌธ์„œ๋Š” **์„œ๋ž ๐Ÿ—„๏ธ, ๋ฌธ์„œ ๐Ÿ“ฐ, ์นด๋“œ ๐Ÿ“‡** ์˜ 3๋‹จ๊ณ„ ๊ตฌ์„ฑ์„ ๊ฐ–์Šต๋‹ˆ๋‹ค.
23+
- **์„œ๋ž** ๐Ÿ—„๏ธ: ํ•˜๋‚˜์˜ ๋ถ€์„œ ๋˜๋Š” ๋ณด์ง์— ์—ฐ๊ด€๋œ ์—…๋ฌด ํŒŒ์ผ๋“ค์˜ ์ง‘ํ•ฉ
24+
- **๋ฌธ์„œ** ๐Ÿ“ฐ: ํ•˜๋‚˜์˜ ์—…๋ฌด๋ฅผ ๊ตฌ์„ฑํ•˜๋Š” ์นด๋“œ๋“ค์˜ ์ง‘ํ•ฉ
25+
- **์นด๋“œ** ๐Ÿ“‡: ์ž‘์€ ์—…๋ฌด๋ฅผ ์ˆ˜ํ–‰ํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ์„ค๋ช…ํ•œ ์งง์€ ๋ฌธ์„œ
26+
27+
<p align="center">
28+
<img src='http://drive.google.com/uc?export=view&id=1A4XxkjSMLXGl4dtebVH6KG0wfLqCMLMT' width="400" height="400" />
29+
</p>
30+
31+
3๋‹จ๊ณ„๋กœ ๊ตฌ์„ฑ๋œ ๋ฌธ์„œ์— ๋”ํ•ด, ๋ฏธ๋ฆฌ ์ œ๊ณต๋œ **์นด๋“œ ํ…œํ”Œ๋ฆฟ**๋“ค์„ ์ด์šฉํ•ด ๋” ์ฝ๊ธฐ ์‰ฝ๊ณ , ์ฒด๊ณ„ํ™”๋œ ๋ฌธ์„œ๋ฅผ ์ž‘์„ฑํ•ด๋ณด์„ธ์š”!
32+
33+
<h3> ๊ทธ๋ฃน, ๋ถ๋งˆํฌ, ๋Œ“๊ธ€ ๊ธฐ๋Šฅ์„ ํ†ตํ•œ ๋ฌธ์„œ ๊ณต์œ  ์„œ๋น„์Šค ๐Ÿค </h3>
34+
35+
<p align="center">
36+
<img src='http://drive.google.com/uc?export=view&id=1A4XxkjSMLXGl4dtebVH6KG0wfLqCMLMT' width="400" height="400" />
37+
</p>
38+
39+
- ๊ฐ™์€ ๋ณด์ง, ๊ฐ™์€ ์†Œ์†์˜ ์‚ฌ์šฉ์ž๋“ค๊ณผ **๊ทธ๋ฃน**์„ ํ˜•์„ฑํ•˜์—ฌ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ๋ฅผ ๊ณต์œ ํ•˜๊ณ , **๋Œ“๊ธ€**์„ ํ†ตํ•ด ์˜๊ฒฌ์„ ๋‚˜๋ˆ„์–ด๋ณด์„ธ์š”!
40+
- ๋งˆ์Œ์— ๋“œ๋Š” ๋ฌธ์„œ๊ฐ€ ์žˆ๋‹ค๋ฉด, **๋ถ๋งˆํฌ** ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ์–ธ์ œ๋“ ์ง€ ๋ฌธ์„œ๋ฅผ ๋‹ค์‹œ ์—ด๋žŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
41+
42+
<h3> ๋ณด์•ˆ ๊ด€๋ฆฌ์ž ๋“ฑ๋ก์„ ํ†ตํ•œ ๊ธฐ๋ฐ€ ์œ ์ถœ ๋ฐฉ์ง€ ๐Ÿ” </h3>
43+
44+
<p align="center">
45+
<img src='http://drive.google.com/uc?export=view&id=1A4XxkjSMLXGl4dtebVH6KG0wfLqCMLMT' width="400" height="400" />
46+
</p>
47+
48+
- ๊ทธ๋ฃน ๋ณ„๋กœ **๋ณด์•ˆ ๊ด€๋ฆฌ์ž**๋ฅผ ๋“ฑ๋กํ•ด ๊ทธ๋ฃน ๋‚ด ๋ฌธ์„œ์—์„œ ๋ณด์•ˆ ์‚ฌํ•ญ์ด ์œ„๋ฐ˜๋˜๊ณ  ์žˆ๋Š”์ง€ ํ™•์ธํ•˜๊ณ , ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
49+
50+
## ์ปดํ“จํ„ฐ ๊ตฌ์„ฑ / ํ•„์ˆ˜ ์กฐ๊ฑด ์•ˆ๋‚ด (Prerequisites)
2851
* ECMAScript 6 ์ง€์› ๋ธŒ๋ผ์šฐ์ € ์‚ฌ์šฉ
2952
* ๊ถŒ์žฅ: Google Chrome ๋ฒ„์ ผ 77 ์ด์ƒ
3053

31-
<h2 id="stacks"> ๊ธฐ์ˆ  ์Šคํƒ (Key Tech Stacks)</h2>
32-
54+
## ๊ธฐ์ˆ  ์Šคํƒ (Technique Used)
3355
### Server(back-end)
34-
- [`nodejs 14.17.6`](https://nodejs.org/en/)
35-
- [`expressjs`](https://expressjs.com/)
36-
- [`MongoDB`](https://www.mongodb.com/)
37-
- [`Docker`](https://www.docker.com/)
38-
- [`Algolia Search`](https://www.algolia.com/)
56+
- [`nodejs 14.17.6`](https://nodejs.org/en/)
57+
- [`expressjs`](https://expressjs.com/)
58+
- [`MongoDB`](https://www.mongodb.com/)
59+
- [`Docker`](https://www.docker.com/)
60+
- [`Algolia Search`](https://www.algolia.com/)
3961

4062
### Front-end
41-
- [`react.js`](https://reactjs.org/)
42-
- [`MaterialUI`](https://mui.com/)
43-
44-
<h2 id="install"> ์„ค์น˜ ์•ˆ๋‚ด (Installaltion Methods)</h2>
63+
- [`react.js`](https://reactjs.org/)
64+
- [`MaterialUI`](https://mui.com/)
4565

66+
## ์„ค์น˜ ์•ˆ๋‚ด (Installation Process)
4667
```bash
4768
$ git clone osamhack2021/App_Flutter_Web_Express_Handover_TeamName
4869
$ yarn install
4970
$ yarn start
5071
```
5172

52-
<h2 id="gettingstarted"> ํ”„๋กœ์ ํŠธ ์‚ฌ์šฉ๋ฒ• (Getting Started) </h2>
53-
-yet to do
73+
## ํ”„๋กœ์ ํŠธ ์‚ฌ์šฉ๋ฒ• (Getting Started)
74+
- yet to do...
5475

55-
<h2 id="teaminfo"> ํŒ€ ์ •๋ณด (Team Info) </h2>
76+
## ํŒ€ ์ •๋ณด (Team Information)
77+
5678
<table width="788">
5779
<thead>
5880
<tr>
@@ -195,8 +217,7 @@ $ yarn start
195217
</tbody>
196218
</table>
197219

198-
<h2 id="license"> ์ €์ž‘๊ถŒ ๋ฐ ์‚ฌ์šฉ๊ถŒ ์ •๋ณด (Copyleft / End User License) </h2>
199-
220+
## ์ €์ž‘๊ถŒ ๋ฐ ์‚ฌ์šฉ๊ถŒ ์ •๋ณด (Copyleft / End User License)
200221
* [MIT](https://github.com/osam2020-WEB/Sample-ProjectName-TeamName/blob/master/license.md)
201222

202223
This project is licensed under the terms of the MIT license.

0 commit comments

Comments
ย (0)