Skip to content

Latest commit

 

History

History
199 lines (141 loc) · 5.85 KB

README.md

File metadata and controls

199 lines (141 loc) · 5.85 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Speech to Text Transcriber

Transcriber based on Watsons STT service
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This project is based on Watson speech to text service. Project is implemented in NodeJS with a PostgreSQL database. It is currenlty being hosted in heroku free tier instance.

The project uses express web framework to cater the user requests.

Application can perform transcription on .mp4 .m4a .mp3 files.

Browse Application

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  1. Node
  2. Watsons speech to text service API key
  3. PostgreSQL database

Installation

  1. Clone the repo 
    git clone https://github.com/kth012/stt-kethiri.git
  2. Install NPM packages 
    npm install
  3. Set the environment variables 
    export DATABASE_URL= ""
export STT_API_KEY= ""
export STT_SERVICE_URL= ""
export PORT = ""

Usage

User Registration

register-page-ss

User Login

login-page-ss

File Upload

fileupload-page-ss

Transcription Response

transcriptionresponse-page-ss

Results

Results can also be obtained via REST endpoint
https://stt-kethiri.herokuapp.com/result?username=abc?password=xxx

result-page-ss

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GPLv3.0 License. See LICENSE for more information.

Contact

Kethiri Sundaralingam - @skethiri93 - [email protected]

Project Link: https://github.com/kth012/stt-kethiri

Acknowledgements