/HackDuke2021

This is a web application that aims to empower visually impaired group by providing image description and text to speech services. This is a project developed within 24 hours in the hackathon HackDuke2021.

Primary LanguageJavaScript

Read For You

Introduction

  • Read For You is a web application developed within 24 hours in the hackathon HackDuke 2021 (23 Oct 2021 - 24 Oct 2021).
  • Read For You aims to empower the visually impaired group by providing image description and text to speech services.
  • This project is hosted on https://readforyou.tech/, using the services from the Google Cloud Platform and domain.com
  • When a user uploads an image, words describing the image will be read out and displayed on screen. When a user uploads a document file (txt, docx, doc) the text will be read out and the contents will be displayed on screen.
  • (Learn more about this project in devpost and in the presentation slides.)

Tech Stacks

  • HTML, CSS ,JavaScript
  • Express.js
  • Google Cloud Vision API
  • Google Cloud Platform
  • Nginx

Setup for Project Development

  1. Install npm modules
npm i

  1. Setup the Google Cloud Vision services

    • Generate an API Key from the Google Cloud Platform
    • Create a JSON file named apiKey.json
    • Insert the API Key in apiKey.json

  2. Set the environment variable for Google API

export GOOGLE_APPLICATION_CREDENTIALS="./apiKey.json"
  1. Run index.js to host the website locally
node index.js
  1. Visit http://localhost:8080/ in the browser