timmyfengz / p-brain.ai

Natural language virtual assistant using Node.js + Bootstrap

P-Brain.ai - Voice Controlled Personal Assistant

Natural language virtual assistant using Node + Bootstrap

Screenshot

Video Introduction To The Project

https://www.youtube.com/watch?v=4EF_qEYNNwU

Dependencies

• Node >= 10
• Python >= 2
• Yarn / npm

Setup

Install

Install Yarn https://yarnpkg.com/en/docs/install

Clone repo, cd into its directory and type yarn & yarn start

Add api info for http://openweathermap.org/api and https://newsapi.org/account to config/index.js

Open Chrome and enter http://localhost:4567/

Say Hey Brain, Brain or Okay Brain followed by your query (i.e Hey Brain, What is the weather in Paris).

Install - Extra Windows Instructions

Install Python: https://www.python.org/downloads/windows/

Install Node.js v6: https://nodejs.org/en/download/

Install Windows Build Tools: npm install --global --production windows-build-tools

Skills

Adding Skills

Add a skill by creating a new folder with the name of your new skill and adding an index.js.

Add functions for intent and {skill_name}_resp to that index, the latter contining the logic that will respond to a query. The {skill_name}_resp function must have a response type of String

In intent add return {keywords:['key 1','key 2'], module:'{skill_name}'} where keywords are the phrases you wish the skill to respond to and {skill_name} is the name of your new skill.

Add module.exports = {intent, get: {skill_name}_resp}; to the end of your index.js

Add that new folder to the skills directory in the project.

And bang, Brain will automatically import and enable your new skill!

API

For more detail on adding skills see the Wiki page Adding Skills.

Clients

Web Client

http://localhost:4567/api/ask?q={query} http://localhost:4567/ http://localhost:4567/settings.html http://localhost:4567/users.html

Raspberry Pi Client

The Raspberry Pi Client for this project is available here: https://github.com/patrickjquinn/P-Brain.ai-RasPi

MagicMirror+P-Brain

Coming Soon!

Android Client

https://github.com/timstableford/P-BrainAndroid

iOS Client

https://github.com/patrickjquinn/P-Brain.ai-iOS

Docker

You can run this application via Docker. Prequisites are that you have docker installed and cloned this repository locally. Then execute the following command to bring-up an instance on http://localhost:4567:

docker-compose up --build

Easter eggs

• One can ask brain about 'trip to mordor'
• or 'what is love'

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]