Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.26 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.26 KB
Raw

Kalita Logo

kalita-js

Kalita a is text-to-speech software with a special focus on data minimization and user privacy. We do not collect any personal data, do not set tracking cookies and do not outsource our service to third-party cloud solutions. The speech synthesis takes place on-premises on your own server and still offers many of the conveniences of a conventional readspeaker.

  • kalita-server is a server written in Python that provides the speech synthesis.
  • kalita-js is a JavaScript client for integration into a website that provides a graphical user interface.

Screenshots

Kalita Screenshot

Build

Before you can embed Kalita into your website, you need to build the software. For this you will need Node.js and npm.

  1. Clone the repository.
git clone https://github.com/azmke/kalita-js
  1. Replace YOUR_KALITA_SERVER with the URL of your Kalita server in the config.json file.
{
  "url": "YOUR_KALITA_SERVER"
}
  1. Install the required modules.
npm run install
  1. Build the source code.
npm run build

Website integration

If the build was successful, you will find the files bundle.min.js and style.min.css among other files in the folder /build. Place these two files on your web server. Afterwards you can include them in your HTML page as follows:

CSS

Copy-paste the stylesheet <link> into your <head> before all other stylesheets to load our CSS:

<link rel="stylesheet" type="text/css" href="style.min.css">

HTML

Add the following <div> element to a position on your page where the graphical interface should be displayed:

<div id="kalita-player"></div>

JS

Our components require the use of JavaScript to function. Place the following <script> near the end of your pages, right before the closing </body> tag, to enable them:

<script src="bundle.min.js"></script>