Speech technology for language education. 📣
The ITSLanguage JavaScript SDK aims to help in building applications for the ITSLanguage platform. It provides easy interfaces to communicate with our [REST and WebSocket API]. We serve several packages through the npmjs.com ecosystem that can be used together. See the table below for all the packages we deliver.
| Package name | Description |
|---|---|
| recorder | ITSLanguage compatible MediaRecorder |
| websocket | ITSLanguage Socketio helper |
Besides npm an umd build of each package is also available on unpkg.com.
| Package name | npm | unpkg |
|---|---|---|
| recorder | @itslanguage/recorder | unpkg.com/@itslanguage/recorder/dist/ |
| websocket | @itslanguage/websocket | unpkg.com/@itslanguage/websocket/dist/ |
The browser compatibility relies on the socket.io support. Version below the minimal supported version are not guaranteed to work. Please see the caniuse page for socket.io for more information
| Chrome | Safari | Firefox | IE | Edge | |
|---|---|---|---|---|---|
| Minimal Version | 84 | 13 | 78 | 9 | 83 |
All the available packages of the SDK will be distributed as npm packages. Package managers that can can work with the npmjs.com registry, like npm and yarn do, can be used to add SDK packages to your project. For simplicity this readme assumes npm as package manager.
Adding ITSLanguage packages into your project is as easy as instructing npm to do so. In the case
of npm this will automatically add an entry in your package.json file. If that does not happen, you
are probably using an older npm version (< 5.x). Consider upgrading to at least > 5.x.. Note that
ITSLanguage publishes its packages scoped, which means that all packages should be prefixed with
@itslanguage/PACKAGE_NAME.
# Example installation of the recorder package
npm install @itslanguage/recordernote: As shown in the table above, all the packages are also published as an UMD bundle via
unpkg.com. This makes it possible to install or download the packages without npm. All needed
dependencies will also be bundled for convenience. See the example below to get an idea on how to
use it.
We do recommend usage with a package manager like npm or yarn though.
<!DOCTYPE html>
<html>
<head>
<title>Some page title</title>
<script src="https://unpkg.com/@itslanguage/[email protected]/dist/api.min.js"></script>
<script>
// The api is now available through global `itslApi`.
itslApi.createItslApi();
</script>
</head>
<body>
Hello, world!
</body>
</html>Consult the readme files of the packages for more information and documentation. See the table above for links to the proper readme files.
Want to contribute? Nice! Good to hear, we would love to get help!
Make sure you read the code of conduct and the
contribution guidelines.
To get support on the SDK you can either create a [new][issue], or e-mail your question to support