README.md

Butler Bot

A Telegram Bot that helps you book meetings rooms. Awesome!

Getting Started

Grab dependencies

npm i

Run the bot

npm start

Running tests (After you have setup the env vars)

npm test

Configuration

• Setup & grant permission to test google calendar, service account and get auth key
• Setup test telegram bot and get bot token
• Copy .sample-env to .env and replace with your own env variables
• Add sample users data in sample-users.js

Contributing

Easy as 1-2-3:

• Step 1: Branch off from develop and work on your feature or hotfix.
• Step 2: Update the changelog.
• Step 3: Create a pull request when you're done.

References:

• Git branching strategy
• Keeping a changelog
• Semver

Report a bug here.

Todo

• [Feature] Improve admin workflow to add / remove rooms opened for booking
• [Feature] Quick command to check available rooms in the next coming x hour
• [Improvement] Improve /any booking flow
• [Feature] Users to state meeting participants and auto send email meeting invites
• [Improvement] Booking insert job queue improvement
• [Improvement] Authenticate to only allow hive users to book (temporary workaround for now)
• [Improvement] Break logs into mutiple streams/ files
• [Improvement] Clean up code