Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 1.91 KB

README.md

File metadata and controls

66 lines (38 loc) · 1.91 KB
Raw

Boost

An open-source motivational bot for Messenger.

Since it is built on the Botpress platform, it is simple, lightweight (~250 lines of code) and portable.

Features

  • Three different categories of videos (work, life and gym)
  • Fetch videos metadata from YouTube
  • Subscription to send daily videos at 8AM (users timezone)

Roadmap

  • Personalize the send time (currently only 8AM)
  • Don't send the same user the same videos

Requirements

Boost requires node (version >= 7.0) and uses npm as package manager.

Boost is powered by Botpress, an open-source bot platform.

Getting started

You should get familiar with Botpress and the main modules this bot uses (botpress-messenger, botpress-broadcast, botpress-scheduler, botpress-subscriptions).

Running the bot

Install the bot:

npm install

Run it:

YOUTUBE_API_KEY=<YOUR API KEY> npm start

The bot should be running at http://localhost:3000

To develop and test locally, we suggest you setup ngrok in the botpress-messenger module.

You must re-run (npm start) after every change to the bot code.

Contributing

Everybody is welcomed to contribute to Boost. Note that only contributions addressing open GitHub issues will be considered. Please open an issue before contributing!

  1. Fork this repo
  2. Make changes in your repo
  3. Submit pull request on this repo

Community (Botpress)

There's a Slack community where you are welcome to join us, ask any question and even help others.

Get an invite and join us now! 👉https://slack.botpress.io

License

Boost is licensed under AGPL-3.0