Skip to content
a Local Intelligent Personal Assistant
JavaScript Shell Dockerfile HTML Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
public
scripts
src
.eslintrc
.gitignore
Dockerfile
LICENSE
Makefile
README.md
gulpfile.js
package.json
setup-linux.sh
setup-mac.sh
setup-pulse.sh

README.md

Kingdom

Kingdom is an intelligent personal assistant, written to run locally on Node.js. All plugins, including speech recognition, are run locally. This way, you don't need to send your voice data to the cloud to get simple things done.

Current plugins include:

  • Weather
  • Control your Hue lighting system
  • Hype Machine music player

Dependencies

Before running Kingdom, make sure to install all of the system dependencies.

  bash setup.sh

This script has only been tested on Ubuntu 16.04LTS and Raspbian OS. If this doesn't work for you, install each system dependency in the file manually. We also have a Dockerfile to create a container with all the correct dependencies on an x86 machine.

In particular, make sure you have the following:

Once all system dependencies have been installed, install the project dependencies

  npm install

Running

First make sure you have a complete configuration file.

To start Kingdom:

  npm start

Developing

To run all tests and lint scripts:

  gulp test

For test coverage:

  gulp coverage
You can’t perform that action at this time.