Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.34 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.34 KB
Raw

telegraml-dashboard

A set of extensions for TelegraML for automatically generating a web dashboard for your bot

Features

  • Default "run" function for bots
  • Compatible with normal TelegraML interface
  • Automatically generate a web interface for your bot, including
    • Viewing bot info/stats
      • Username
      • Uptime
    • Toggling (enabling/disabling) commands
    • Leaving groups

Screenshots

Dashboard page showing 2 commands and 1 group

Porting TelegraML bots

In order to port a bot from standard TelegraML to TelegraML-dashboard, you first need to add the ocamlfind package telegraml-dashboard to your build system. Then, add the following line to your code:

open TelegramDashboard

Next, you need to switch from using the normal Api.Mk functor to using MkDashboard instead. The Api.BOT that you pass to it can remain 100% the same and all calls into to the resulting module should remain unaffected by the change.

Finally, you need to replace your main function with one that will start the Opium server up. A default function for this is exposed by the generated module from MkDashboard:

val run : ?log:bool -> unit -> unit

The ?log parameter will allow you to enable or disable logging API errors to stdout.