https://github.com/govtechsg/butler-bot

Telegram bot for booking meeting rooms
https://github.com/govtechsg/butler-bot

bots room-booking telegram telegram-bot

Last synced: 2 months ago
JSON representation

Telegram bot for booking meeting rooms

• Host: GitHub
• URL: https://github.com/govtechsg/butler-bot
• Owner: GovTechSG
• License: mit
• Created: 2016-12-19T03:19:29.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-02-20T06:54:28.000Z (11 months ago)
• Last Synced: 2024-04-14T12:36:37.486Z (9 months ago)
• Topics: bots, room-booking, telegram, telegram-bot
• Language: JavaScript
• Homepage:
• Size: 838 KB
• Stars: 18
• Watchers: 18
• Forks: 14
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Butler Bot

[![Build Status](https://travis-ci.org/GovTechSG/butler-bot.svg?branch=master)](https://travis-ci.org/GovTechSG/butler-bot)

[![Known Vulnerabilities](https://snyk.io/test/github/GovTechSG/butler-bot/badge.svg)](https://snyk.io/test/github/GovTechSG/butler-bot)

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

## Getting Started

Grab dependencies

```javascript

npm i

```

Run the bot

```javascript

npm start

```

Running tests (After you have setup the env vars)

```javascript

npm test

```

## Configuration

* [Setup & grant permission to test google calendar, service account and get auth key](https://github.com/yuhong90/node-google-calendar/wiki#setup-service-accounts)

* Setup test telegram bot and [get bot token](https://core.telegram.org/bots#6-botfather)

* Copy [.sample-env](.sample-env) to `.env` and replace with your own env variables

* Add sample users data in [sample-users.js](src/data/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](http://nvie.com/posts/a-successful-git-branching-model/)

* [Keeping a changelog](http://keepachangelog.com/)

* [Semver](http://semver.org/)

Report a bug [here](https://github.com/GovTechSG/butler-bot/issues).

## 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