DongyoungKwon

Update README.md

Showing 1 changed file with 34 additions and 51 deletions
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
<!--
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]-->
# Teleprompter-SST
<!-- TABLE OF CONTENTS -->
<details open="open">
<summary>Table of Contents</summary>
<ol>
<li><a href="## 🎙 프로젝트 소개">About The Project</a></li>
<li><a href="## 📋 License">License</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
# Teleprompter-STT
## Table of Contents
- [프로젝트 소개](#-프로젝트-소개)
- [주요 기능](#-주요-기능)
- [Directory 구조](#-directory-구조)
- [설치 방법](#keyboard-설치-방법)
- [팀원](#-팀원)
- [Reference](#-reference)
- [License](#-license)
## 🎙 프로젝트 소개
- 음성에 맞춰 대본을 화면에 실시간으로 출력하는 프롬프터 서비스
- 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
Teleprompter-STT
├── client ---> Front-end [React]
│ ├── public ---> 정적 파일 보관
│ │ ├── favicon.ico
│ │ ├── index.html
│ │ ├── manifest.json
│ │ └── robots.txt
......@@ -63,50 +45,51 @@ Teleprompter-SST
│ │ └── styles.js ---> PrompterPage.js Style
│ ├── .gitignore
│ ├── package-lock.json
│ ├── package.json
│ └── yarn.lock
│ └── package.json
├── .gitignore
├── LICENSE ---> MIT License
├── package-lock.json
├── package.json
├── README.md
├── server.js ---> Back-end
└── yarn.lock
└── server.js ---> Back-end [Node.js Express]
```
## ⌨️ 설치 방법
## :keyboard: 설치 방법
#### client 폴더 이동
`$ cd Teleprompter-SST/client`
`$ cd Teleprompter-STT/client`
#### package.json에 명시된 모듈 설치
#### React에 필요한 모듈 설치
`$ npm install`
#### Teleprompter-SST 폴더 이동
#### Build File 생성
`$ npm run build`
#### Teleprompter-STT 폴더 이동
`$ cd ..`
#### package.json에 명시된 모듈 설치
#### Node.js에 필요한 모듈 설치
`$ npm install`
#### 시작
`$ npm run dev`
#### Local Address 접속
`http://localhost:3000`
`$ npm run server`
## 🧑‍💻 팀원
## 👥 팀원
- 권동영 (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
Teleprompter-STT is [MIT licensed](./LICENSE).
<br></br>
[👆Back To The Top](#Teleprompter-STT)
\ No newline at end of file
......