https://github.com/mallozup/fullrocketmetal
rocketchat reminder and bot powered by clojure
https://github.com/mallozup/fullrocketmetal
bot clojure edn event functional-programming lisp opensource rocketchat rocketchat-apps
Last synced: 6 days ago
JSON representation
rocketchat reminder and bot powered by clojure
- Host: GitHub
- URL: https://github.com/mallozup/fullrocketmetal
- Owner: MalloZup
- License: epl-2.0
- Created: 2019-03-25T11:29:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-02T11:30:07.000Z (about 6 years ago)
- Last Synced: 2025-05-06T20:41:05.930Z (about 2 months ago)
- Topics: bot, clojure, edn, event, functional-programming, lisp, opensource, rocketchat, rocketchat-apps
- Language: Clojure
- Homepage:
- Size: 62.5 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
An event bot for rocketchat.
## Released versions:
for a released version, take a look at GitHub releases.
## High-level Description:
As user of a Rocketchat, you can automatize your regular meeting events with `fullrocketmetal` easy.
Fullrocketmetal let you schedule in a crontab regulary syntax, a regular `message` event/reminder, which will sent to a channel name of your server.
## Quickstart
Use either the released jar or the devel one
## Configuration
Make sure this 2 edn files are in the same directory to the JAR clojure file you execute.
1) create a `.rocketchat.edn` file in same dir of `fullrocketmetal jar` with following content:
```
{:credentials {:username "myusername" :server-url "myserver-rocketchat-url.com" :token "my-token-rocketchat"}}
```
2) create a `event.edn` file in same dir of `fullrocketmetal` with following content:
the `cron-schedule` is a cron syntax time.
```
{:reminders [
{:channel-name "clojure" :cron-schedule "0 0/1 * * * ?" :message "[autogenerated] @here i'm a fullrocket-message-autogenerated-running each minute.https://github.com/MalloZup/fullrocketmetal "},
;;{:channel-name "my-other-channel" :cron-schedule "0 0/1 * * * ?" :message "i'm just a text after the default message"}
,
]}
```
this will send to `channel-name` a `message` which is a reminder, and you can specify the frequence of the message via `cron-schedule` which follow the crontab syntax.
## Build from src
Use `lein uberjar` to build the jar
Use `java -jar fullrocketmetal-VERSION-standalone.jar`.
This will run `fullrocketmetal`
# Technical infos:
This project is using rocketchat missile library and quartz scheduler.
( https://github.com/MalloZup/missile)
Fullrocketmetal plan only to implement the rocketchat Messanger.
I plan maybe to implent a generic bot where one could plugin others client (Slack,irc etc) using same syntax.
https://github.com/MalloZup/memoro