DongyoungKwon / test

Go to a project
Toggle navigation Toggle navigation pinning
DongyoungKwon
1c955e2f 1 parent c73f53ea

Update README.md

Inline Side-by-side
Showing 1 changed file with 34 additions and 51 deletions
1 -<!-- PROJECT SHIELDS --> 1 +# Teleprompter-STT
2 -<!-- 2 +
3 -*** I'm using markdown "reference style" links for readability. 3 +## Table of Contents
4 -*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). 4 + - [프로젝트 소개](#-프로젝트-소개)
5 -*** See the bottom of this document for the declaration of the reference variables 5 + - [주요 기능](#-주요-기능)
6 -*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. 6 + - [Directory 구조](#-directory-구조)
7 -*** https://www.markdownguide.org/basic-syntax/#reference-style-links 7 + - [설치 방법](#keyboard-설치-방법)
8 ---> 8 + - [팀원](#-팀원)
9 -<!-- 9 + - [Reference](#-reference)
10 -[![Contributors][contributors-shield]][contributors-url] 10 + - [License](#-license)
11 -[![Stargazers][stars-shield]][stars-url] 11 +
12 -[![Issues][issues-shield]][issues-url] 12 +
13 -[![MIT License][license-shield]][license-url]
14 -[![LinkedIn][linkedin-shield]][linkedin-url]-->
15 -
16 -# Teleprompter-SST
17 -
18 -<!-- TABLE OF CONTENTS -->
19 -<details open="open">
20 - <summary>Table of Contents</summary>
21 - <ol>
22 - <li><a href="## 🎙 프로젝트 소개">About The Project</a></li>
23 - <li><a href="## 📋 License">License</a></li>
24 - </ol>
25 -</details>
26 -
27 -<!-- ABOUT THE PROJECT -->
28 ## 🎙 프로젝트 소개 13 ## 🎙 프로젝트 소개
29 - 음성에 맞춰 대본을 화면에 실시간으로 출력하는 프롬프터 서비스 14 - 음성에 맞춰 대본을 화면에 실시간으로 출력하는 프롬프터 서비스
30 - Untact시대에 화상회의에서 편하게 발표할 수 있도록 도와주는 서비스 15 - Untact시대에 화상회의에서 편하게 발표할 수 있도록 도와주는 서비스
31 16
32 17
33 -## 📜 주요기능 18 +## 📜 주요 기능
34 -
35 - [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) && [**string-similarity API**](https://www.npmjs.com/package/) 사용 19 - [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) && [**string-similarity API**](https://www.npmjs.com/package/) 사용
36 - Real-time Script Output 20 - Real-time Script Output
37 21
38 22
39 ## 🗂 Directory 구조 23 ## 🗂 Directory 구조
40 -
41 ```bash 24 ```bash
42 -Teleprompter-SST 25 +Teleprompter-STT
43 -├── client ---> Front-end 26 +├── client ---> Front-end [React]
44 │ ├── public ---> 정적 파일 보관 27 │ ├── public ---> 정적 파일 보관
45 -│ │ ├── favicon.ico
46 │ │ ├── index.html 28 │ │ ├── index.html
47 │ │ ├── manifest.json 29 │ │ ├── manifest.json
48 │ │ └── robots.txt 30 │ │ └── robots.txt
...@@ -63,50 +45,51 @@ Teleprompter-SST ...@@ -63,50 +45,51 @@ Teleprompter-SST
63 │ │ └── styles.js ---> PrompterPage.js Style 45 │ │ └── styles.js ---> PrompterPage.js Style
64 │ ├── .gitignore 46 │ ├── .gitignore
65 │ ├── package-lock.json 47 │ ├── package-lock.json
66 -│ ├── package.json 48 +│ └── package.json
67 -│ └── yarn.lock
68 │ 49 │
69 ├── .gitignore 50 ├── .gitignore
70 ├── LICENSE ---> MIT License 51 ├── LICENSE ---> MIT License
71 ├── package-lock.json 52 ├── package-lock.json
72 ├── package.json 53 ├── package.json
73 ├── README.md 54 ├── README.md
74 -├── server.js ---> Back-end 55 +└── server.js ---> Back-end [Node.js Express]
75 -└── yarn.lock
76 ``` 56 ```
77 57
78 - 58 +## :keyboard: 설치 방법
79 -
80 -## ⌨️ 설치 방법
81 59
82 60
83 #### client 폴더 이동 61 #### client 폴더 이동
84 -`$ cd Teleprompter-SST/client` 62 +`$ cd Teleprompter-STT/client`
85 63
86 -#### package.json에 명시된 모듈 설치 64 +#### React에 필요한 모듈 설치
87 `$ npm install` 65 `$ npm install`
88 66
89 -#### Teleprompter-SST 폴더 이동 67 +#### Build File 생성
68 +`$ npm run build`
69 +
70 +#### Teleprompter-STT 폴더 이동
90 `$ cd ..` 71 `$ cd ..`
91 -#### package.json에 명시된 모듈 설치 72 +
73 +#### Node.js에 필요한 모듈 설치
92 `$ npm install` 74 `$ npm install`
93 75
94 #### 시작 76 #### 시작
95 -`$ npm run dev` 77 +`$ npm run server`
96 -
97 -#### Local Address 접속
98 -`http://localhost:3000`
99 78
100 79
101 -## 🧑‍💻 팀원 80 +## 👥 팀원
102 - 권동영 (2016110307) 81 - 권동영 (2016110307)
103 - 김다솔 (2017110268) 82 - 김다솔 (2017110268)
104 83
105 84
85 +
106 ## 📋 Reference 86 ## 📋 Reference
107 - [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) 87 - [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API)
108 - [**string-similarity API**](https://www.npmjs.com/package/) 88 - [**string-similarity API**](https://www.npmjs.com/package/)
109 89
110 -<!-- LICENSE --> 90 +
91 +
111 ## 📋 License 92 ## 📋 License
112 -Teleprompter-SST is [MIT licensed](./LICENSE).
...\ No newline at end of file ...\ No newline at end of file
93 +Teleprompter-STT is [MIT licensed](./LICENSE).
94 +<br></br>
95 +[👆Back To The Top](#Teleprompter-STT)
...\ No newline at end of file ...\ No newline at end of file
......