Skip to content

An "empty" Hubot project that can be used to build your own Slack bot.

License

Notifications You must be signed in to change notification settings

emiddelburg/bot-zero

 
 

Repository files navigation

bot-zero

Hubot is a fantastic project that enabled us to build great bots. The bot-zero project aims to give you a cleaned up version with some examples that run on ES6 (instead of Coffee-script).

Build Status forever coding style: JavaScript Standard Style) License: MIT

Getting started

Starting this project is really easy:

  1. Fork this project (top right corner)
  2. Clone your forked project to your pc.
  3. Goto http://slackapi.github.io/hubot-slack/#getting-a-slack-token to read up on how to get a Slack token for your bot.
  4. Add the token to your environment.
  5. Open a terminal and navigate to your bot directory.
  6. Enter npm install to install the NodeJs packages.
  7. Start the bot using npm start.
  8. Enjoy!

Good to know

Packages
We've included some packages:

  • axios: a promise-based HTTP client. Makes it easier to use promises of your HTTP requests.
  • dotenv: allows you to store environment variables in the .env file in the root of the project.
  • hubot-command-mapper: allows for the mapping of commands with parameters to the Hubot without the need for regular expressions.

NPM
Use NPM to interact with the bot:

  • npm start will start the bot.
  • npm test will kick of the tests of the bot. They are located in the tests directory. Testing is done using Hubot Pretend. It'll also tests against JavaScript Standard Style to make sure your coding is consistent.

Clean up
The bot was generated using the Slack Developer Kit for Hubot. It was "cleaned" using a script from Cleaning up the Default Hubot Installation.

Tech

We're using the following stack:

  • NodeJs
  • ES6
  • Hubot
  • NPM

About

An "empty" Hubot project that can be used to build your own Slack bot.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.6%
  • Batchfile 1.2%
  • Shell 1.2%