Code Monkey home page Code Monkey logo

butters's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.