- Make sure you have installed git
- Inside your terminal, navigate to a directory you'd like to have this project live in.
- Run
git clone https://github.com/louman347/sphinxbot.git
- You should now have all the code from the repository and be in the master branch. Now run
git checkout -b <your new branch name>
before you start changing any code. (<your new branch name>
can be whatever you want it to be). - Make sure your computer has npm installed.
- Check that you are inside the repository's root directory and then run
npm install
. This will get you all the necessary node packages to start working on the project locally. - Run
bin/hubot -n sphinxbot
to run the bot in the command line. RunHUBOT_SLACK_TOKEN=<slack token> bin/hubot -a slack -n sphinxbot
to run the bot inside Slack (replacing<slack token>
with the token found under the hubot Slack customization). Be aware that running the bot inside Slack will likely produce double messages from the bot in Slack due to the live, remote version and the local version running simultaneously.
All the commands that have been added on top of the commands that came with the Hubot project (so far all are in dsp.coffee
)
- "the weather" - Doesn't need to be directed at Sphinxbot
- Current temperature, and high and low for the day for Rolla, MO
- "who is the best pledge class" - Needs to be directed at Sphinxbot
- "Upsilon is the best pledge class, of course!"
- "who isn't the best pledge class" - Needs to be directed at Sphinxbot
- "Who do you think? It's obviously Tau."
- Responds to post requests to the url:
/hubot/chores/remind
- Request body
- user:
Slack username
(no quotation marks) - chore:
chore title
(no quotation marks) - description:
[string array of instructions on how to complete the chore]
(yes quotation marks, for each instruction)
- user:
- Authentication
- Basic auth - stored in
EXPRESS_USER
andEXPRESS_PASSWORD
environment variables
- Basic auth - stored in