npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

speech-react

v0.5.23

Published

Speech-React

Downloads

10

Readme

Speech-React

Speech-React ist eine React Typescript-Bibliothek zur Integration von Sprachdiensten, wie Sprachausgabe (TTS), Spracherkennung (ASR), Sprachverstehen (NLU), Dialogverarbeitung (NLP) und Aktionsausführung in einer React Web-Seite oder Web-App. Kern von Speech-React ist ein BotService, der Dialoge eines Dialogskripts ausführen kann.

Daneben git es folgende einzeln verwendbare Dienste:

  • SpeakService für die Sprachausgabe
  • ListenService für die Spracherennung
  • IntentService für das Sprachverstehen
  • ActionService für die Aktionserzeugung
  • DialogService für die Dialogausführung

In Speech-React können für die Sprachausgabe (TTS) und das Sprachverstehen (NLU) auch Clouddienste verwendet werden. Dazu wird ein eigener Account des jeweiligen Cloud-Dienstes benötigt.

Speech-Framework

Die Speech-React Bibliothek benötigt das Speech-Framework, welches unter https://github.com/lingualogic/speech-framework in Github zu finden ist.

Um in eigenen Projekten Speech-React nutzen zu können, muss das Speech-Framework NPM-Package von der LinguaLogic-Seite heruntergeladen werden, in den eigenen Projektordner kopiert werden und vor Speech-React installiert sein. Das Speech-Framework NPM-Package wird mit folgendem Befehl installiert:

$ npm install speech-framework-0.5.23.tgz

Alternativ kann das Speech-Framework auch über das offizielle globale NPM-Repository installiert werden:

$ npm install speech-framework

Wird speech-react aus dem globalen NPM-Repository installert, wird speech-framework automatisch mitinstalliert.

Letzte Version

Wir empfehlen für neue React-Projekte die Verwendung von Typescript, ansonsten kann Speech-React auch mit JavaScript verwendet werden.

Voraussetzungen

Wir haben Speech-React auf Mac OS X 10.14, Win 10 und Ubuntu 20.04 getestet. Als Plattformen können eingesetzt werden:

  • Mac OS X >= 10.14
  • Windows >= 10
  • aktuelles Linux (z.B. Ubuntu 20.04)

Es wird die aktuellste React-Version empfohlen

  • React >= 17.x

Grundsätzlich ist das Speech-React SDK in Chrome, Firefox, Opera, Safari und Edge nutzbar, allerdings hängt die Sprachausgabe unter diesen Browsern von der zugrunde liegenden Text-to-Speech Engine der jeweiligen Plattformen ab. Die Spracheingabe funktioniert bisher nur in Chrome.

  • Chrome >= 80 Windows/Linux/MacOS (Html5: TTS, ASR)(Amazon: TTS, Google: NLU)
  • Firefox >= 80 Windows/Linux/MacOS (Html5: TTS)(Amazon: TTS, Google: NLU)
  • Opera >= 70 Windows/MacOS (Html5: TTS)(Amazon: TTS, Google: NLU) Linux (kein Html5)
  • Safari >= 14 MacOS/iOS (Html5: TTS)(Amazon: TTS, Google: NLU)
  • Edge >= 80 Windows (Html5: TTS)(Amazon: TTS, Google: NLU)

NodeJS muss installiert sein.

  • NodeJS >= 12.X und <= 14.X (LTS-Version)

Als weitere Plattformen können Android und iOS mit Cordova verwendet werden:

  • Cordova >= 10 für Android >= 5.1 und iOS >= 10

Für Cordova müssen weitere Programme zur Entwicklung von Android- und iOS-Apps installiert werden. Informationen hierzu finden sich unter docs/platform/Cordova.md.

Will man den Clouddienst verwenden, muss ein eigener Account eingerichtet werden und die Cloud-Komponente des Speech-Frameworks separat in die eigene App eingebunden werden. Wie man dies macht, findet man unter docs/cloud/Cloud.md

Installation

Die Installation kann vom globalen NPM-Repository aus erfolgen, oder als lokale Installation erzeugt man sich sein NPM-Package selbst.

NPM-Package

Zur Installation von Speech-React ins eigene Projekt, im Projektverzeichnis folgenden Befehl eingeben:

$ npm install speech-react

Installiert man speech-react auf diese Art, wird speech-framework automatisch mitinstalliert.

lokales Package

Zuerst muss das Speech-React Github-Repsitory unter https://github.com/lingualogic/speech-react mit folgendem Befehl geklont werden:

$ git clone https://github.com/lingualogic/speech-react
$ cd speech-react

danach werden alle NPM-Pakete für Speech-React mit folgendem Befehl installiert:

$ npm install

anschließend kann man optional die Unit-Tests von Speech-React starten:

$ npm test

zum Schluß wird das NPM-Paket für Speech-React im dist/ Ordner erzeugt:

$ npm run build

Die API-Dokumentation kann mit folgenden Befehl in docs/api erzeugt werden:

$ npm run docs

Das im dist/ Ordner erzeugte npm-Paket 'speech-react-0.5.23.tgz' kann in den eigenen React Projektordner kopiert werden.

Die Installation des 'speech-react-0.5.23.tgz' npm-Paketes erfolgt im eigenen React Projektordner mit folgendem Befehl:

$ npm install speech-react-0.5.23.tgz

Danach kann Speech-React im eigenen React-Projekt verwendet werden.

Alternativ kann das fertige Speech-React npm-Paket auch von der LinguaLogic-Webseite heruntergeladen werden.

Deinstallation

Speech-React kann mit folgendem Befehl wieder deinstalliert werden:

$ npm uninstall speech-react

gebrochener Code gegenüber der Vorversion

  • wird das Google-Module eingebunden, muss jetzt auch der Parameter googleServerUrl bei den googleCredentials eingetragen und der Konfiguration mitübergeben werden.

Bekannte Probleme

  • Unter Chrome in iOS funktioniert die Spracheingabe nicht

Dokumentation

Schnelleinstieg

Architektur

Services

Cloud-Dienste

Plattformen

API-Referenz

Roadmap

Release Notizen

Beispiel-Apps

Im examples Ordner sind mehrere kleine Beispiele für die einzelnen Services von Speech-React zu finden. Zum Ausführen der Beispiele darf nicht in den Beispielordner gewechselt werden. Von dort aus funktioniert der Start der jeweiligen Beispiel-App nicht, da globale NPM-Packages aus dem Projektverzeichnis benötigt werden.

Folgender Befehl ist im Hauptprojektverzeichnis für das SpeakService-Beispiel einzugeben:

$ npm run speak

Für das ListenService-Beispiel ist folgender Befehl einzugeben:

$ npm run listen

Projektverantwortliche (LinguaLogic Team)

Projektorganisation: Leo Füchsel ([email protected])

Technische Entwicklung: Stefan Brauer ([email protected])

Mitwirkende

In Projekten verwendet


Lizenz

Speech-React wurde als Open Source unter der MIT-Lizenz veröffentlicht.