srikarg / Jarvis

A personal assistant built with Node.js.

Jarvis

What is it?

Jarvis is a Node.js bot that strives to emulates the functionality of J.A.R.V.I.S. from the Iron Man movie series. Some of its commands can be found in commands.js.

How can I install Jarvis?

Clone this repository and then run npm install to install the server's dependencies. Finally, run node server.js to fire up the server and navigate your web browser to localhost:3000.

How can I help?

1. First, enter your new command into commands.coffee. The data that the user passed to the command can be accessed by the query variable.

   exports.myAwesomeCommand = (query, res) ->
   	# Do something awesome.
   

2. Next, add your command's trigger, prefixed by an exclamation point, into the switch block in server.coffee. You will need to call the function you just created in the previous step. Also, note that the data the user passed to the command is the message parameter for the command's function. The res variable allows the function to send its output back to the user.

   when '!yourAwesomeCommandTrigger' then commands.myAwesomeCommand message, res
   

3. Finally, add your command's documentation into the object returned by exports.getDocs() in help.coffee as the following:

   myAwesomeCommand: 'This is a description of myAwesomeCommand. `!yourAwesomeCommandTrigger query`'