Giter Site home page Giter Site logo

sc-voice

Javascript implemenation of SuttaCentral Voice Assistance (SC-Voice) for vision-impaired. Includes:

Prerequisites

  • Linux Debian 10 or Ubuntu 20.04
  • Nodejs 14.x
  • AWS Polly account (required)

Installation

With a Linux console, install the software:

git clone https://github.com/sc-voice/sc-voice.git
cd sc-voice

Initialization requires super user access for your computer and you will be asked to enter your computer superuser password.

./scripts/init.sh

Now update the content but do not reboot (i.e., Respond with no when asked to reboot)

./scripts/update-latest

As part of installation you will need to configure the AWS Polly TTS service adapter.

Configure Amazon AWS Polly

The Amazon AWS Polly Text-to-Speech service can be used to convert sutta text to speech. To enable AWS Polly, you will need to configure your credentials

Login to your AWS account and go to the IAM dashboard|Delete your root access keys|Manage Security Credentials|Access Keys...|Create New Access Key

aws configure
Launch localhost server
npm start

Open up localhost in your local browser and you will see Voice. When you are done with voice, type CTRL-C in the terminal.

Unit tests

npm run test

Unit tests take about 2 minutes. The unit tests require AWS Polly.

To execute a single unit/test, simply insert the text TESTTEST into the it("...") title argument. Then run npm run test:test, which selectively tests such unit tests whenever a source file changes. This makes quick work of debugging or implementing a feature.

Test failures
  • Some tests validate online APIs and may fail due to timeouts or EAI_AGAIN responses. Re-run tests and they should pass.
  • Some tests validate online content which may change. For example, the number of search results may change slightly. Update the unit tests accordingly and re-run tests.

Scripts

Command line script Description
npm run test Run service unit tests (about 2 minutes).
npm run serve Compile and reload SC-Voice Vue for development at http://localhost:8080
npm run build Create production Vue build in dist folder
npm run lint Run esLint to check *.js and *.vue files `

Other

Directory structure

  • src contains Javascript source code
  • test contains Javascript unit tests
  • scripts contains miscellaneous scripts
  • local contains local content not archived in git
  • public Vue/Vuetify public HTML assets
  • words contains language lexicons for search and speech.

SuttaCentral Voice's Projects

bilara-verse icon bilara-verse

HTML files for verses generated from suttacentral/bilara-data

ebt-deepl icon ebt-deepl

Javascript library for EBT translation using DeepL

express-status-monitor icon express-status-monitor

🚀 Realtime Monitoring solution for Node.js/Express.js apps, inspired by status.github.com, sponsored by https://dynobase.dev

js-ebt icon js-ebt

Javascript browser utilities for the Pali canon

pali icon pali

Pali Javascript library

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.