geexup/clockify-telegram-bot repository overview

⁠Clockify Telegram Bot

Telegram bot for better & faster interaction with Clockify Timetable

⁠Try deployed version

Just search in Telegram Messenger for @clockify_bot

⁠Install

1. Clone this repository:

$: git clone https://github.com/geexup/clockify-telegram-bot.git && cd ./clockify-telegram-bot

1. Install dependencies:

$: npm i

OR

$: yarn

1. Get mongoDB⁠ up and running

⁠Run

1. Go to Bot Father (@BotFather) in Telegram and get your bot token
2. Paste token into BOT_TOKEN in src/environment/presets/dev.ts
3. Run bot:

$: yarn dev

⁠Docker

Here⁠ you can find ready images

⁠Build

To build docker image just execute this command:

$: docker build -t <IMAGE_TAG_NAME> .

⁠RUN

Simple run:

docker run --cap-add=SYS_ADMIN --name clockify-bot geexup/clockify-telegram-bot

You can pass into container your own environment preset with bot token and mongoDB address as well:

docker run -it --cap-add=SYS_ADMIN \
  -v <PATH_TO_CONFIG>:/srv/environment/presets/preset.js \
  -e BOT_CURRENT_PRESET=<PRESET_NAME> \
  geexup/clockify-telegram-bot

⁠TODO

• Add tests
• Add state machine to scenes
• Add Google Authenticator for Admin proof