Skip to content

connlaoi-boilerplates/voice-assistant-boilerplate

Repository files navigation

Voice Assistant Boilerplate

Build Status

This boilerplate uses Snips and Artyom to process and handle intents to your hearts content!

It uses the Voice Assistant API to serve voice commands.

If you plan on using this boilerplate, please start with the API. :)

Features

  • Artyom & Snips Voice Assistant w/ Fully Customizable Intents and Wakeword
  • Easy WaveNet Integration
  • Pre-Configured BrowserRouter
  • Ant Design UI
  • Pre-Configured Modal Windows
  • Pre-Configured eslint and Prettier code formatter
  • React Hot Loader
  • Linux/MacOS/Windows

Built With

  • Antd - UI Design library
  • Node - Dependency and Deployment Manager
  • Express - Routing Framework for Node
  • React - Framework for state-based UI
  • Redux - Predictable state container

Example

Demo GIF

Prerequisites

Node.js must be installed. Other libraries will be managed within Node.

Installing

git clone git@github.com:connlaoi/voice-assistant-boilerplate.git
cd voice-assistant-boilerplate
npm install

# remove boilerplate git references
rm ./.git

# create a new repo on GitHub
https://github.com/new

# initialize a new local repo
git init

# connect your local repo to your new GitHub repo
git remote add origin https://github.com/user/repo.git

# push your local repo to your GitHub repo
git push origin master

Scripts

# run development mode
npm run dev

# run prettier (cleans up your code)
npm run prettier

# run lint (your laundry list)
npm run lint

# run production mode
npm run build
npm start

Configure for Personal Voice API

Now that we have our files in place and the site is able to run, let's integrate our new voice api route!

Simply open the 'src/client/constants/voiceProperties.js' file and edit it to match your own personal information.

That should do it!

Default Login credentials are any email and password.


Congratulations, you are now serving a voice assistant in the browser!


Authors

  • Connlaoi Smith - Ongoing Development - connlaoi

Acknowledgments

  • Amit Maraj - Initial work on React Boilerplate - maraja

See also the list of contributors who participated in this project.