1. Getting started

clone repo

Note this assistant currently only supports Mac OSX computers. Use other operating systems at your own risk.

    cd ~
    git clone git@github.com:jim-schwoebel/nala.git
    cd nala
    python3 setup.py 

If you want to have fun, you can also listen to the lion king themesong!

    open https://www.youtube.com/watch?v=GibiNy4d4gc 

set up environment variables

To set up environment variables you need to run

    open .bash_profile 

To set up a google speech account, check out their documentation. You'll need to set this up as an environment variable to a .json file with the credentials for google speech. You'll need these environment vars to continue:

    export GOOGLE_APPLICATION_CREDENTIALS=''
    export SUDO_PASSWORD=''

The GOOGLE_APPLICATION_CREDENTIALS is a path to a .json file for your credentials to use the Google Speech API. This must be in your environment vars. For example, it could be something like /Users/jimschwoebel/Desktop/appcreds/keyname.json

The SUDO_PASSWORD is environment variable for the password to the root account. This is used for shutting down and restarting the computer. If you don't care about these commands in your voice assistant, then don't worry about inserting it here.

Note none of this data is shared on a 3rd party server; Nala is a completely local voice assistant for research and personal use.

start the application

You're now ready to register an account and start the application. To do this, run:

    cd ~
    cd nala
    python3 nala.py

You will then be asked for your name and email address.

Now you're all setup and ready to use Nala!