README
¶
goSadTgBot — SadBot's Framework for development of Telegram bots
This framework is based on:
- the go-telegram-bot-api library;
- PostgreSQL as database (by using pgx).
Packages
- base contains base types like container for request environment or object for sending requests.
- app provides an additional container for the application environment and method for processing the updates.
- server allows you to use a WebHook.
- metrics allows you to publish the
/metricsendpoint for Prometheus. - storage creates a database connection and runs the migrations located in the
db/migrationsdirectory. - settings consists of an interface that must provide user settings to the bot.
- wizard provides facilities to create forms with fields of different types.
- logconst is just a set of constants for use in
log.WithField(logconst.*, ...).
Examples of usage
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app is mostly needed to get rid of the import cycle that would take place if this code resides in the 'base' package.
|
Package app is mostly needed to get rid of the import cycle that would take place if this code resides in the 'base' package. |
|
Package base defines basic types and a wrapper around the original [tgbotapi.BotAPI] struct.
|
Package base defines basic types and a wrapper around the original [tgbotapi.BotAPI] struct. |
|
Package logconst consists of constant values representing the fields in log messages.
|
Package logconst consists of constant values representing the fields in log messages. |
|
Package metrics provides metrics for Prometheus.
|
Package metrics provides metrics for Prometheus. |
|
Package server provides functions to set a webhook and start a server to process incoming requests.
|
Package server provides functions to set a webhook and start a server to process incoming requests. |
|
Package settings consists of an interface that must provide user settings to the bot.
|
Package settings consists of an interface that must provide user settings to the bot. |
|
Package storage creates a database connection and runs the migrations located in the `db/migrations` directory.
|
Package storage creates a database connection and runs the migrations located in the `db/migrations` directory. |
|
Package wizard provides support for field based forms defined by client code.
|
Package wizard provides support for field based forms defined by client code. |
Click to show internal directories.
Click to hide internal directories.