DongyoungKwon

Add new file

Showing 1 changed file with 105 additions and 0 deletions
1 +# Teleprompter-SST
2 +
3 +<!-- TABLE OF CONTENTS -->
4 +<details open="open">
5 + <summary>Table of Contents</summary>
6 + <ol>
7 + <li>
8 + <a href="#about-the-project">About The Project</a>
9 + <ul>
10 + <li><a href="#built-with">Built With</a></li>
11 + </ul>
12 + </li>
13 + <li>
14 + <a href="#getting-started">Getting Started</a>
15 + </li>
16 + <li><a href="#license">License</a></li>
17 + </ol>
18 +</details>
19 +
20 +<!-- ABOUT THE PROJECT -->
21 +## 🎙 프로젝트 소개
22 + - 음성에 맞춰 대본을 화면에 실시간으로 출력하는 프롬프터 서비스
23 + - Untact시대에 화상회의에서 편하게 발표할 수 있도록 도와주는 서비스
24 +
25 +
26 +## 📜 주요기능
27 +
28 + - [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) && [**string-similarity API**](https://www.npmjs.com/package/) 사용
29 + - Real-time Script Output
30 +
31 +
32 +## 🗂 Directory 구조
33 +
34 +```bash
35 +Teleprompter-SST
36 +├── client ---> Front-end
37 +│ ├── public ---> 정적 파일 보관
38 +│ │ ├── favicon.ico
39 +│ │ ├── index.html
40 +│ │ ├── manifest.json
41 +│ │ └── robots.txt
42 +│ ├── src
43 +│ │ ├── components
44 +│ │ │ └── Teleprompter.js ---> 음성인식 && 문장유사도 수행
45 +│ │ ├── pages
46 +│ │ │ ├── MainPage.js ---> 메인 화면
47 +│ │ │ └── PrompterPage.js ---> 대본 출력 화면
48 +│ │ ├── App.css
49 +│ │ ├── App.js ---> Router
50 +│ │ ├── App.test.js
51 +│ │ ├── index.css
52 +│ │ ├── index.js
53 +│ │ ├── reportWebVitals.js
54 +│ │ ├── serviceWorker.js
55 +│ │ ├── setupTests.js
56 +│ │ └── styles.js ---> PrompterPage.js Style
57 +│ ├── .gitignore
58 +│ ├── package-lock.json
59 +│ ├── package.json
60 +│ └── yarn.lock
61 +
62 +├── .gitignore
63 +├── LICENSE ---> MIT License
64 +├── package-lock.json
65 +├── package.json
66 +├── README.md
67 +├── server.js ---> Back-end
68 +└── yarn.lock
69 +```
70 +
71 +
72 +
73 +## ⌨️ 설치 방법
74 +
75 +
76 +#### client 폴더 이동
77 +`$ cd Teleprompter-SST/client`
78 +
79 +#### package.json에 명시된 모듈 설치
80 +`$ npm install`
81 +
82 +#### Teleprompter-SST 폴더 이동
83 +`$ cd ..`
84 +#### package.json에 명시된 모듈 설치
85 +`$ npm install`
86 +
87 +#### 시작
88 +`$ npm run dev`
89 +
90 +#### Local Address 접속
91 +`http://localhost:3000`
92 +
93 +
94 +## 🧑‍💻 팀원
95 +- 권동영 (2016110307)
96 +- 김다솔 (2017110268)
97 +
98 +
99 +## 📋 Reference
100 +- [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API)
101 +- [**string-similarity API**](https://www.npmjs.com/package/)
102 +
103 +<!-- LICENSE -->
104 +## 📋 License
105 +Teleprompter-SST is [MIT licensed](./LICENSE).
...\ No newline at end of file ...\ No newline at end of file