Skip to content

Commit c34ad75

Browse files
authored
Docs : Added table of contents to readme
1 parent 2efbbf7 commit c34ad75

1 file changed

Lines changed: 33 additions & 19 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,53 @@
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>
919

10-
## ๊ธฐ๋Šฅ ์„ค๋ช…
11-
- 3๋‹จ๊ณ„ ๋ฌธ์„œ(์„œ๋ž ๐Ÿ—„๏ธ, ๋ฌธ์„œ ๐Ÿ“ฐ, ์นด๋“œ ๐Ÿ“‡) ๊ตฌ์„ฑ์œผ๋กœ ์‰ฝ๊ฒŒ ๊ด€๋ฆฌํ•˜๋Š” ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
12-
- ๊ทธ๋ฃน ์ƒ์„ฑ, ๋ถ๋งˆํฌ, ๋Œ“๊ธ€ ๊ธฐ๋Šฅ๋“ค๋กœ ํ•จ๊ป˜ ๊ณต์œ ํ•˜๋Š” ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
13-
- ๊ด€๋ฆฌ์ž ๊ธฐ๋Šฅ์œผ๋กœ ๋ณด์•ˆ์œ„๋ฐ˜์œผ๋กœ๋ถ€ํ„ฐ ์•ˆ์ „ํ•œ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
20+
<h2 id="features"> ๊ธฐ๋Šฅ ์„ค๋ช… (Key Features) </h2>
21+
22+
- 3๋‹จ๊ณ„ ๋ฌธ์„œ(์„œ๋ž ๐Ÿ—„๏ธ, ๋ฌธ์„œ ๐Ÿ“ฐ, ์นด๋“œ ๐Ÿ“‡) ๊ตฌ์„ฑ์œผ๋กœ ์‰ฝ๊ฒŒ ๊ด€๋ฆฌํ•˜๋Š” ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
23+
- ๊ทธ๋ฃน ์ƒ์„ฑ, ๋ถ๋งˆํฌ, ๋Œ“๊ธ€ ๊ธฐ๋Šฅ๋“ค๋กœ ํ•จ๊ป˜ ๊ณต์œ ํ•˜๋Š” ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
24+
- ๊ด€๋ฆฌ์ž ๊ธฐ๋Šฅ์œผ๋กœ ๋ณด์•ˆ์œ„๋ฐ˜์œผ๋กœ๋ถ€ํ„ฐ ์•ˆ์ „ํ•œ ์ธ์ˆ˜์ธ๊ณ„ ๋ฌธ์„œ
25+
26+
<h2 id="prerequisites"> ์ปดํ“จํ„ฐ ๊ตฌ์„ฑ / ํ•„์ˆ˜ ์กฐ๊ฑด ์•ˆ๋‚ด (Prerequisites)</h2>
1427

15-
## ์ปดํ“จํ„ฐ ๊ตฌ์„ฑ / ํ•„์ˆ˜ ์กฐ๊ฑด ์•ˆ๋‚ด (Prerequisites)
1628
* ECMAScript 6 ์ง€์› ๋ธŒ๋ผ์šฐ์ € ์‚ฌ์šฉ
1729
* ๊ถŒ์žฅ: Google Chrome ๋ฒ„์ ผ 77 ์ด์ƒ
1830

19-
## ๊ธฐ์ˆ  ์Šคํƒ (Technique Used)
31+
<h2 id="stacks"> ๊ธฐ์ˆ  ์Šคํƒ (Key Tech Stacks)</h2>
32+
2033
### Server(back-end)
21-
- [`nodejs 14.17.6`](https://nodejs.org/en/)
22-
- [`expressjs`](https://expressjs.com/)
23-
- [`MongoDB`](https://www.mongodb.com/)
24-
- [`Docker`](https://www.docker.com/)
25-
- [`Algolia Search`](https://www.algolia.com/)
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/)
2639

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

31-
## ์„ค์น˜ ์•ˆ๋‚ด (Installation Process)
3246
```bash
3347
$ git clone osamhack2021/App_Flutter_Web_Express_Handover_TeamName
3448
$ yarn install
3549
$ yarn start
3650
```
3751

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

41-
## ํŒ€ ์ •๋ณด (Team Information)
42-
55+
<h2 id="teaminfo"> ํŒ€ ์ •๋ณด (Team Info) </h2>
4356
<table width="788">
4457
<thead>
4558
<tr>
@@ -182,7 +195,8 @@ $ yarn start
182195
</tbody>
183196
</table>
184197

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

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

0 commit comments

Comments
ย (0)