Just a pot managing bot
DISCLAIMER: It has nothing to do with Weed
- /active Fetch all active pots (includes locked)
- /completed Fetch all completed pots
- /join Join an active unlocked pot
- /new Start a new pot
- /lock Lock a pot you created, preventing others from joining
- /end End a pot you created
- NodeJS 16.8.0
- MongoDB 5.0
From the app root:
- Run
npm installto install all the dependencies - Rename
.env.sampleto.envand update the values to your needs - You'll need to create your own Telegram bot using @BotFather
- Use the bot token and assign it to
TELEGRAM_BOT_TOKENin.envfile
- Use the bot token and assign it to
- Install MongoDB. On macOS, run
brew tap mongodb/brewbrew install [email protected]
MongoDB is used as the primary data store and also to persist scheduled tasks
- Start server
brew services start [email protected]- Ensure connectivity by running
mongosh myFirstDatabase
- Ensure connectivity by running
- From the app root, run
npm run devto start the bot
NOTE Make sure you /start the bot before you try interacting with the bot.
Telegram doesn't allow bots to message a user without permission.
- Install dependencies
npm install - Start the script by running
npm start - Stop:
npm stop - Status:
npm run status
If you wish to deploy it to Heroku, you can do so by clicking below (Make sure you have the ENV vars configured):
MIT License
Copyright (c) 2021 Mohnish Thallavajhula [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.