best-queue

A self-hosted substitute for Queue

Project plans:

1. Application ✅
2. Docker config for an easily deployable image ✅
3. Automatic deployment to dockerhub/artifactory 🔁

Example usage:

Joining queue

Showing queue

Swapping places

Setting up and running the application

Create the slack app and set it up for local development using ngrok

1. Go to the slack apps page
2. Create a new app -> From scratch
3. When asked for Add features and functionality, activate Slash commands and Bots
4. Install ngrok and add your authtoken
5. Start your ngrok instance using ngrok http http://localhost:8080 (swap the port if 8080 is occupied), and save your forwarding url shown (should look something like https://5d71-111-1-243-109.ngrok-free.app).
6. In your slack apps page, go to Slash commands, and create one for each of the endpoints /qjoin, /qleave and /qshow. In the Request URL field, enter your forwarding url as the endpoint base url. /qjoin Example: https://5d71-111-1-243-109.ngrok-free.app/qjoin
7. In your slack apps page go to Interactivity & Shortcuts and enable it using the toggle. In the Request URL field, enter your forwarding url appended with /buttonproxy. Example: https://5d71-111-1-243-109.ngrok-free.app/buttonproxy
8. Install your app in your slack workspace of choice. This is done on the home page of your slack app -> Install your app -> Install in workspace

Deploy the back-end application

Option 1 - using docker

1. Run docker-compose up. The latest image will be pulled and the application starts accepting requests at localhost:8080.

Option 2 - run with python

1. Clone this repository, and start the flask application on port 8080 using python3 app.py. If you are missing flask, install it using pip3 install flask.

Use the commands in any text channel in your slack workspace - the queue app should work! ⭐