README.md
3.58 KB
Teleprompter-STT
Demo Link(Only work in chrome) π https://teleprompterstt.herokuapp.com
Table of Contents
- νλ‘μ νΈ μκ°
- μ£Όμ κΈ°λ₯
- System Architecture
- Directory ꡬ쑰
- μ€μΉ λ°©λ²
- νμ
- Reference
-
License
π νλ‘μ νΈ μκ°
- μμ±μ λ§μΆ° λλ³Έμ νλ©΄μ μ€μκ°μΌλ‘ μΆλ ₯νλ ν둬νν° μλΉμ€
- Untactμλμ νμνμμμ νΈνκ² λ°νν μ μλλ‘ λμμ£Όλ μλΉμ€
π μ£Όμ κΈ°λ₯
- Web Speech API && string-similarity API μ¬μ©
- Real-time Script Output
π System Architecture
π Directory ꡬ쑰
Teleprompter-STT
βββ client ---> Front-end [React]
β βββ public ---> μ μ νμΌ λ³΄κ΄
β β βββ 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
β
βββ .gitignore
βββ LICENSE ---> MIT License
βββ package-lock.json
βββ package.json
βββ README.md
βββ server.js ---> Back-end [Node.js Express]
μ€μΉ λ°©λ²
βοΈ React & Express μλ² λμ ꡬλ (Local Serverλ‘ λμ)
client ν΄λ μ΄λ
$ cd Teleprompter-STT/client
Reactμ νμν λͺ¨λ μ€μΉ
$ npm install
Teleprompter-STT ν΄λ μ΄λ
$ cd ..
Node.jsμ νμν λͺ¨λ μ€μΉ
$ npm install
React & Express μλ² λμ μμ
$ npm run dev
βοΈ Express μλ²λ‘λ§ κ΅¬λ (Herokuλ‘ λ°°ν¬ κ°λ₯)
client ν΄λ μ΄λ
$ cd Teleprompter-STT/client
Reactμ νμν λͺ¨λ μ€μΉ
$ npm install
Build File μμ±
$ npm run build
Teleprompter-STT ν΄λ μ΄λ
$ cd ..
Node.jsμ νμν λͺ¨λ μ€μΉ
$ npm install
Express μλ² μμ
$ npm run server
π₯ νμ
- κΆλμ (2016110307)
- κΉλ€μ (2017110268)
π Reference
π License
Teleprompter-STT is MIT licensed.