Giter Club home page Giter Club logo

cmm-cipherbot's Introduction

Slack Rails Bot Starter

Setup

Prerequisites(Recommended)

A domain(or a subdomain) is ready to host the application

If you need to set up a new Slack app:

  1. Create a new app here
  2. Navigate to the OAuth & Permissions page and add the following Bot Token Scopes:
  • users:read
  • channels:read
  • groups:read
  • chat:write
  • commands
  • incoming-webhook
    BASE_URL stands for https://slackbot-hosted-domain.com hereafter.
    Use this url for Redirect : BASE_URL
  1. Activate Interactivity & Shortcuts and add this url: BASE_URL/api/slack/action
  2. Activate Slash Commands adding two slash commands /ping, /quiz and use this url: BASE_URL/api/slack/command
  3. Activate Event Subscriptions subscribing to the event type member_joined_channel and add this url: BASE_URL/api/slack/event(This step needs the application to be running :D so you can skip this and come back a few mins later)
  4. Navigate to the App Home page and toggle Always Show My Bot as Online (according to your reference)

Clone the repository and install dependencies

bundle install

Prepare .env file

cp .env.example .env

Go to https://api.slack.com/apps and click your application.
Grab the infomation needed for .env file from Basic Information section.

Run the application

Use this command to run the app on your server:

rails s -e production -b 0.0.0.0

Open the BASE_URL in your browser

Deployment

Not limited to any specific platform

License

MIT

TODO

[x] Change the interactive message templates to the new ones
[ ] Add Rubocop linting
[ ] Add Specs
[ ] Add TravisCI build flow
[ ] Add Contribution Guide

Credit

This project is built on top of the Slack Ruby Bot Server and Slack Ruby Bot Server Events
A big thanks to Daniel Doubrovkine's great work.

Made with โค๏ธ by CrazyOptimist ๐Ÿฌ

cmm-cipherbot's People

Contributors

dwyn avatar

Watchers

James Cloos avatar  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.