Add new file

DongyoungKwon
Commit a3c5c20fc598f1108d0db2958725cbde72fb8461 a3c5c20f 0 parents
Showing 1 changed file with 105 additions and 0 deletions
README.md
--- a/README.md 0 → 100644
View file @a3c5c20
+++ b/README.md 0 → 100644
View file @a3c5c20
+ # Teleprompter-SST
+ 
+ <!-- TABLE OF CONTENTS -->
+ <details open="open">
+   <summary>Table of Contents</summary>
+   <ol>
+     <li>
+       <a href="#about-the-project">About The Project</a>
+       <ul>
+         <li><a href="#built-with">Built With</a></li>
+       </ul>
+     </li>
+     <li>
+       <a href="#getting-started">Getting Started</a>
+     </li>
+     <li><a href="#license">License</a></li>
+   </ol>
+ </details>
+ 
+ <!-- ABOUT THE PROJECT -->
+ ## 🎙 프로젝트 소개
+   - 음성에 맞춰 대본을 화면에 실시간으로 출력하는 프롬프터 서비스
+   - Untact시대에 화상회의에서 편하게 발표할 수 있도록 도와주는 서비스
+ 
+ 
+ ## 📜 주요기능
+ 
+   - [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) && [**string-similarity API**](https://www.npmjs.com/package/) 사용
+   - Real-time Script Output
+ 
+ 
+ ## 🗂 Directory 구조
+ 
+ ```bash
+ Teleprompter-SST
+ ├── client                        ---> Front-end
+ │   ├── public                    ---> 정적 파일 보관
+ │   │   ├── favicon.ico
+ │   │   ├── index.html
+ │   │   ├── manifest.json
+ │   │   └── robots.txt
+ │   ├── src
+ │   │   ├── components
+ │   │   │   └── Teleprompter.js   ---> 음성인식 && 문장유사도 수행 
+ │   │   ├── pages
+ │   │   │   ├── MainPage.js       ---> 메인 화면
+ │   │   │   └── PrompterPage.js   ---> 대본 출력 화면
+ │   │   ├── App.css
+ │   │   ├── App.js                ---> Router
+ │   │   ├── App.test.js
+ │   │   ├── index.css
+ │   │   ├── index.js
+ │   │   ├── reportWebVitals.js
+ │   │   ├── serviceWorker.js
+ │   │   ├── setupTests.js
+ │   │   └── styles.js             ---> PrompterPage.js Style
+ │   ├── .gitignore
+ │   ├── package-lock.json
+ │   ├── package.json
+ │   └── yarn.lock
+ │
+ ├── .gitignore
+ ├── LICENSE                       ---> MIT License
+ ├── package-lock.json
+ ├── package.json
+ ├── README.md
+ ├── server.js                     ---> Back-end         
+ └── yarn.lock
+ ```
+ 
+ 
+ 
+ ## ⌨️ 설치 방법
+ 
+ 
+ #### client 폴더 이동
+ `$ cd Teleprompter-SST/client`
+ 
+ #### package.json에 명시된 모듈 설치
+ `$ npm install`
+ 
+ #### Teleprompter-SST 폴더 이동
+ `$ cd ..`
+ #### package.json에 명시된 모듈 설치
+ `$ npm install`
+ 
+ #### 시작
+ `$ npm run dev`
+ 
+ #### Local Address 접속
+ `http://localhost:3000`
+ 
+ 
+ ## 🧑‍💻 팀원
+ - 권동영 (2016110307)
+ - 김다솔 (2017110268)
+ 
+ 
+ ## 📋 Reference
+ - [**Web Speech API**](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API)
+ - [**string-similarity API**](https://www.npmjs.com/package/)
+   
+ <!-- LICENSE -->
+ ## 📋 License
+ Teleprompter-SST is [MIT licensed](./LICENSE).
\ No newline at end of file