Code Monkey home page Code Monkey logo

issuebot's Introduction

IssueBot

A Discord bot for creating GitHub issues.

Install Instructions

Note: Due to NPM package linking requiring root access on system-wide NPM installations, it's recommended to use NVM.

Clone the repository:

$ git clone --recursive https://github.com/LeagueSandbox/IssueBot.git
$ cd IssueBot/issuebot

Install dependencies:

$ npm install

Now create a Discord application and an associated bot. Write down the Bot token, since you will need it in a bit.

Next, create a personal access token on GitHub with the public_repo permission. Also write down this token.

Add the Discord bot to your Discord server you want to use this functionality on.

Note: How to do the above three steps is out of the scope of this project README. A quick Google to the right documentation should help you with this.

Go to your project and create the configuration file.

$ cp config.json.template config.json

Edit config.json and insert your Discord token, GitHub token and your GitHub user/organization name.

Note: The user/organization name needs to be from the same account of which you generated the personal access token for.

Run the bot:

$ npm start

You should see the following output:

user@system:~/IssueBot/issuebot$ npm start

> [email protected] start /home/user/IssueBot/issuebot
> tsc -p . && node built/issuebot.js

Loading commands...
Mapped Function to !issue
Bot ready

Your bot should now be online in your Discord.

Usage

To use it, type the following in Discord where the bot can read it:

!issue REPO "title" "body"

Replace REPO with the repository you have access to. A new GitHub issue should be created through the bot.

Docker

You can provide the required options via environment variables as follows:

  • GITHUB_NAME: The github user/organization name
  • GITHUB_TOKEN: The github user access token
  • DISCORD_TOKEN: The discord bot token

issuebot's People

Contributors

mythicmaniac avatar wavehack avatar molenzwiebel avatar matthewfrench avatar

Watchers

James Cloos avatar

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.