This project is a Slack bot that sends reminder messages to a specified Slack channel. The bot reads messages from a JSON file, selects a random message, and posts it to the channel at a specified time.
- Reads messages from a JSON file
- Selects a random message to send
- Posts messages to a specified Slack channel
- Configurable via environment variables
- Go 1.18 or later
- A Slack workspace and a bot token
- A JSON file containing the messages
- Install Docker for building and pushing container images
- Install Docker Compose version 2.32.1 or later for spinning the application up as a container locally
-
Clone the repository:
git clone https://github.com/yourusername/slack-reminder-bot.git cd slack-reminder-bot -
Install dependencies:
go mod tidy
These configurations are also required when running the application as a docker container
Create a .env file and copy the environment variables from .env.dist into it:
cp .env.dist .envConfigure the following environment variables with the appropriate values:
SLACK_TOKEN: Your Slack bot tokenSLACK_CHANNEL_ID: The ID of the Slack channel where the bot will post messagesAFAS_URL: The URL to be included in the reminder message
-
Create a JSON file named
messages.jsonin theinputdirectory with the following structure:{ "messages": [ "Message 1", "Message 2", "Message 3" ] } -
Run the bot directly:
go run main.go
-
Build and run the bot as a container locally:
docker compose up --build
Note
To remove the container and its attached volumes:
docker compose down -vTo run the unit tests, use the following command:
go test ./...main.go: The main entry point of the applicationblocks.go: Contains the function to create Slack message blocksblocks_test.go: Unit tests forblocks.goday-utils_test.go: Additional utility testsinput/messages.json: JSON file containing the messagesdocker-compose.yml: the docker compose file used for spinning up the container
Contributions are welcome! Please open an issue or submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.