https://github.com/botpress/Boost
🤖 Boost, the open-source Messenger motivational bot 🔥
https://github.com/botpress/Boost
bot botpress botpress-messenger bots chatbot
Last synced: about 21 hours ago
JSON representation
🤖 Boost, the open-source Messenger motivational bot 🔥
- Host: GitHub
- URL: https://github.com/botpress/Boost
- Owner: botpress
- License: agpl-3.0
- Created: 2016-12-20T21:20:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-18T23:01:14.000Z (about 9 years ago)
- Last Synced: 2025-04-06T09:43:19.732Z (about 1 year ago)
- Topics: bot, botpress, botpress-messenger, bots, chatbot
- Language: JavaScript
- Homepage: http://m.me/BoostFuel
- Size: 661 KB
- Stars: 45
- Watchers: 7
- Forks: 24
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-projects - Boost - 🤖 Boost, the open-source Messenger motivational bot 🔥 ⭐48 `JavaScript` (📦 Legacy & Inactive Projects)
README
# Boost
An open-source motivational bot for Messenger.
Since it is built on the [Botpress](https://github.com/botpress/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](https://nodejs.org) (version >= 7.0) and uses [npm](https://www.npmjs.com) as package manager.
Boost is powered by [Botpress](https://github.com/botpress/botpress), an open-source bot platform.
## Getting started
You should get familiar with [Botpress](https://github.com/botpress/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= npm start
```
The bot should be running at `http://localhost:3000`
To develop and test locally, we suggest you setup [ngrok](https://ngrok.com/) 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](https://slack.botpress.io) 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](https://slack.botpress.io)
## License
Boost is licensed under [AGPL-3.0](/LICENSE)