remind-us

README

remind-us

Schedule and generate custom reminders and send via custom alerters.

remind-us, can generate custom reminders and alerters using a dynamically configured file. What you can do with this application is that how you can use it for. Deploy as a Cron Job, run automatically at start-up as a background process, etc.

Warning: A PoC project, currently in Alpha.

Features

• NEW! Reminder: GitLab (PRs)
• NEW! Alerter: Slack (Webhook)
• Dynamic configuration support
• Easy to use integration and alerter interfaces
• Easy cron job integration
• ... and much more! - Explore and contribute!

Screenshots

GitLab: Slack

Installation

• Via Go

$ go get -u github.com/Dentrax/remind-us

• Via Docker

$ docker build -t remind-us \
                  --build-arg VERSION=`git describe --abbrev=0 --tag` \
                  --build-arg COMMIT=`git rev-parse --short HEAD` \
                  --build-arg DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
                  -f Dockerfile .

Usage

• Run the binary

$ remind-us --config-file "./config.yaml"

• Run on Docker

$ docker run -v `pwd`/config.yaml:/app/config.yaml -it remind-us

Configuration

integrations:
  gitlab:
    baseURL: <https://gitlab.com>
    token: <token>
    listen:
      areas:
        - type: "PR"
      groups:
        - <list-of-group-id>
alerts:
  slack:
    webhook: "<your-slack-webhook-endpoint>"
    channel: "<#channel>"
    username: "<username>"
    icon: "<:icon:>"

TO-DO

• Add integration: Jira
• Add integration: Todoist
• Add integration: GitHub
• Add integration: Quates
• Add alerter: stdout
• Concurrency requests?

License

remind-us was created by Furkan 'Dentrax' Türkal

The base project code is licensed under Apache License 2.0 unless otherwise specified. Please see the LICENSE file for more information.

Best Regards