Giter VIP home page Giter VIP logo

scrabblinator's Introduction

Scrabblinator

Scrabblinator micro service with the intention to integrate it with Slack's Slash Commands API.

It was copied from Glossiator for the core Slack parsing and response.

How it works

Run the Docker container

Scrabblinator is a micro service which can be hosted in your own environment by running the following Docker command:

docker run -d -p 8083:8083 -e PREFIX="scrabble-" -e GENMODE="emoji" -e TOKENS="{secret token}" bigjonroberts/scrablinator:latest

The Docker container must be launched with at least one environment variable:

  • TOKENS

TOKENS is a semi-colon ; delimited list of secret tokens that you will be given from Slack's Slash Commands configuration page (see below).

Optional parameters

Currently there is one optional environment variable which can be set inside the Docker container to specify the maximum distance between a search term and an entry in the glossary to count as a match: PREFIX.

The default value is set to "".

Integrate with Slack's Slash Commands API

The next step is to integrate it with Slack's Slash Commands API.

  1. Click on the "Add Configuration" button to add a new configuration.
  2. Enter the desired command. e.g. /scrabble
  3. Enter the URL to the self hosted scrabblinator app. The correct endpoint is called /scrabble.
  • Example: https://scrabblinator.my-server.com/scrabble
  1. Choose POST from the method drop down.
  2. Use the auto-generated token from the Token field to configure the Docker container (see above).
  3. Configure the remaining fields to your likes. Pick a name and icon for the Slack bot and fill in the optional help text.
  4. Click "Save Integration" and the setup is complete!

Now you should be able to go into your Slack channel and be able to type /scrabble hello and get a successful response from the Scrabblinator app.

License

GNU General Public License v3

scrabblinator's People

Contributors

dustinmoris avatar bigjonroberts avatar spencerwi avatar

Watchers

James Cloos avatar  avatar

scrabblinator's Issues

slash command is not converting the letter 'z'

There are tests now that actually detect this bug.
They can be run via either of the following commands:
dotnet test ScrabblinatorTests/ScrabblinatorTests.fsproj
docker build -t scrabblinator .

what does this project do?

The project's name caught my eye in a Hacktoberfest issue search, but I can't tell from the Readme what it does.

Skimming through the source, it looks like it maybe adds a slash command to convert a string of chars into a series of slackmojis that you need to have already installed?

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.