Slacker (you may also write it as "slacker") is a framework written in Nim (as a nimble package) for creating Slack app servers. Slacker takes inspiration from Slack's own framework Bolt which is available in Python, JavaScript, and Java flavours.
>= 2.0.4
Make sure you have a working Nim installation; being a version equal to or greater than the one mentioned above. If you don't have Nim installed in your machine, you can install Nim by following the instructions here.
Once you have Nim installed in your machine, you can install slacker using nimble install.
$ nimble install github.com/bsljth/slackerOnce you have installed slacker (the above scripts installs slacker for your system), you need to add it to your project. First, create your project using nimble
$ nimble init your_project_name
# answer all the prompted questions that follow
# ...
$ cd your_project_nameYou can also create a project folder using mkdir and cd into it and run nimble init.
Once you have created your project, add the line: requires "slacker >= 0.1.0" to your project's .nimble file in the root folder (there's only one such file in a project).
# your_project_name.nimble
# Package
version = "0.1.0"
author = "[YOUR NAME]"
description = "[DESCRIPTION]"
license = "[LICENSE]"
srcDir = "[SOURCE FOLDER]"
bin = @["file_name"]
# Dependencies
requires "nim >= 2.0.4"
requires "slacker >= 0.1.0"Here's how you can initialise your Slack app using slacker. Within the /src/ folder, add the following to your main (starting point) .nim file.
Note: You can configure which directory should be your source directory for the project and which should be your starting point by configuring the srcDir and bin values in your .nimble file.
Add the following to your main .nim file.
# /src/your_project_name.nim
import slacker
let config = ?
# config's data structure is yet to be decided
app = slacker.New(config)
# config will contain the token and signing-secret.
let port = 3000
app.start(port)
MIT
PS: I can set apart only about an hour every day (won't be working on Sundays) to work on this for now. So, development on this would be extremely slow.
- app initialising function/struct
- app.start method
- app.message method to listen to messages
- say proc to send a message
- app.action method to respond to named events
- app.message to take Regex as triggering message argument
- say proc to send message as "blocks"
...(to be completed)