Skip to content

cadia-lvl/WebRICE

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

WebRICE

WebRICE (Web Reader ICE) is an open source web reader in development at Reykjavik University. We hope that Icelandic developers will add this free software to their websites to enable Icelandic audiences to listen to the web instead of reading it.

WebRICE logo

Installation

  1. Install packages with: npm install
  2. Run with: npm run dev

Chrome Extension

WebRICE is also available as an extension on the Chrome web store: https://chrome.google.com/webstore/detail/webrice/mmijkiiefioinbdgbadgghcchfilmlmp. The code for the extension is in the webrice-chrome-extension repo.

Usage

To include WebRICE's compiled CSS and JS in your website, add the following lines:

<!-- CSS only -->
<link rel="stylesheet" href="http://www.webrice.is/WebRICE_styles.css" crossorigin="anonymous">
<!-- JavaScript Bundle -->
<script src="http://www.webrice.is/WebRICE.js" crossorigin="anonymous"></script>

But WebRICE will only be visible on your site if you add this tag for the WebRICE toolbar:

<!-- Div for WebRICE's buttons -->
<div id="webrice"></div>

and this id to the HTML tag containing your text.

id="webriceTextContainer"
<!-- example <div id="webriceTextContainer"> Text </div>-->

A demo of WebRICE can be found at https://cadia-lvl.github.io/WebRICE.

NOTE! WebRICE depends on the Tiro TTS API. The code to their API is available on their gitlab page.

Contributing

Use the following linters: eslint and stylelint. They will be run on every pull request. This project is mainly written in TypeScript. Make sure your TypeScript follows the Google JavaScript style guide, and the MDN HTML reference. Also, validate the generated HTML5 with: https://validator.w3.org/ Then submit a pull request of your changes.

License

This project is licensed under Apache 2.0.

Contact

If you have any inquiries or comments, please contact us at webrice@ru.is.

Authors/Credit

Reykjavik University

  • Judy Fong judyfong@ru.is
  • Ragnheiður Þórhallsdóttir
  • Róbert Kjaran
  • Safa Jemai
  • Sunneva Þorsteinsdóttir sunnevath@ru.is
  • Þorsteinn Daði Gunnarsson

Acknowledgements

This project was funded by the Language Technology Programme for Icelandic 2019-2023. The programme, which is managed and coordinated by Almannarómur, is funded by the Icelandic Ministry of Education, Science and Culture.

We use icons created from Material Design.