telegram-account-bot

module
v0.0.0-...-b52a236 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2024 License: MIT

README

English | 简体中文

Telegram 记账机器人

这是一个 Telegram 记账机器人,可以帮助你记录支出和收入。

部署

  1. 安装 Docker 和 Docker Compose
  2. 克隆本仓库到本地
  3. 将 env 目录中的 .example 文件都重命名为 .env 文件,并按需修改数据库名称、密码等配置
  4. 在重命名后的 bot.env 文件中修改 TELEBOT_TOKEN 为你自己的 Telegram Bot Token
  5. 在终端中进入项目目录,运行 docker-compose up -d 启动容器,如果你不需要 OpenAPI 功能,则执行 docker-compose up -d bot 即可
  6. 打开 Telegram,搜索你的 Bot,开始使用

使用

以下是目前可用的命令:

/start - 开始使用

/day - 查看当日账单

/month - 查看当月账单

/set_keyboard - 设置快捷键盘

/cancel - 取消当前操作

/set_balance - 设置余额

/balance - 查询余额

/create_token 创建用于 OpenAPI 的 token

/disable_all_tokens 废弃所有 token

TODO

  • Automatically update Bot Commands
  • Open API
  • Multilingual
  • Natural language interface

Directories

Path Synopsis
cmd
api
dal
bill
Package bill is a generated GoMock package.
Package bill is a generated GoMock package.
telegram
Package telegram is a generated GoMock package.
Package telegram is a generated GoMock package.
user
Package user is a generated GoMock package.
Package user is a generated GoMock package.
mock
telebotmock
Package telebotmock is a generated GoMock package.
Package telebotmock is a generated GoMock package.
service
Package telebot is a generated GoMock package.
Package telebot is a generated GoMock package.
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL