Skip to content

HellooooNewman/lightbox-quote-checker-slackbot

Repository files navigation

Lightbox Quote Checker

The Lightbox Quote Checker is a tool that helps you determine if a message can be displayed on a lightbox sign, considering character limits, substitutions, and length constraints. It integrates into Slack as a bot for easy use within your team.

Lightbox

Integrates into Slack as a bot

Web Version Demo

Features:

  • Character Substitutions: Supports alternatives like 3 for E
  • Character Limits: Ensures no more than a specified number of each character (e.g., only 3 E’s)
  • Sentence Length Check: Limits total length to 40 characters
  • Invalid Character Check: Supports only A-Z, 0-9, #, &, @
  • Word Length Check: Limits words to a maximum of 10 letters
  • Line Break Limits: Allows up to 3 line breaks per sentence
  • Slack Integration: Adds a bot to Slack for easy access
  • Character Modal: Displays available characters for user reference
  • Built with Bolt.js: Uses the Bolt framework for Slack apps

Running the bot

Run on Heroku for free You can immediately deploy and start using the bot by clicking the button below:

Deploy

You will need to enter your slack bot API key and bot name to complete the setup.

Environment Variables

Requires the following environment variables:

Variable Description
SLACK_AUTH_TOKEN The API key for your slack bot
SLACK_SIGNING_SECRET The signing secret for your slack bot
PORT The port the bot will run on

Examples

Works

/lightbox-sentence-check Long urls are the feature

Original Text: Long urls are the feature
LONG URLS
ARE THE
FEATUR3

Doesn't work

/lightbox-sentence-check how's this work then?

Original Text: how's this work then?
Unsupported characters in quote.

Feature Requests

Feel free to create an issue to suggest new features or improvements!

About

Slackbot for checking and formatting lightbox quotes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •