reactPorcupine - React Web Quick Start

  • Wake Word Detection
  • Offline Hotword Detection
  • Local Voice Commands
  • Always Listening
  • Voice Activation

Compatibility

  • Chrome, Edge
  • Firefox
  • Safari

Install the NPM packages

Using Porcupine with React requires installing three packages: the binding package, @picovoice/porcupine-web-react, the language-specific web worker package (e.g. @picovoice/porcupine-web-en-worker), and the @picovoice/web-voice-processor.

Use yarn or npm to install the packages to your project:

yarn add @picovoice/porcupine-web-react @picovoice/porcupine-web-en-worker @picovoice/web-voice-processor

(or)

npm install @picovoice/porcupine-web-react @picovoice/porcupine-web-en-worker @picovoice/web-voice-processor

Demo application

There is a Vue demo project available on the Porcupine GitHub repository. The demo project was bootstrapped with Create React App.

Clone Picovoice GitHub repository

If using SSH, clone the Porcupine repository with:

git clone --recurse-submodules [email protected]:Picovoice/porcupine.git

If using HTTPS, then type:

git clone --recurse-submodules https://github.com/Picovoice/porcupine.git

Install dependencies and run

Use yarn or npm to install the demo dependencies and start it:

yarn
yarn start

(or)

npm install
npm run start

Open http://localhost:3000 to view it in the browser.

Try Porcupine

The demo is listening for the built-in wake words "Picovoice" and "Alexa". Say:

"Picovoice"

or

"Alexa"

The detections will appear on the page.

Custom Wake Words

You can create custom Porcupine wake word models using Picovoice Console. Making Porcupine wake word models for the Web platform requires an Enterprise account.


Issue with this doc? Please let us know.