https://github.com/juliuste/chore-score-bot
Telegram bot for randomly assigning chores to your flatmates.
https://github.com/juliuste/chore-score-bot
deployment telegram-bot
Last synced: 12 months ago
JSON representation
Telegram bot for randomly assigning chores to your flatmates.
- Host: GitHub
- URL: https://github.com/juliuste/chore-score-bot
- Owner: juliuste
- License: isc
- Created: 2019-11-20T23:10:13.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-10-08T03:33:43.000Z (over 2 years ago)
- Last Synced: 2024-10-17T06:02:39.456Z (over 1 year ago)
- Topics: deployment, telegram-bot
- Language: JavaScript
- Size: 4.01 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# chore-score-bot
Has the dishwasher in your apartment been in dire need of unloading for days and none of your roommates (including you) feel like doing it? Does the garbage can attract more flies than the bowl of vinegar your parents advised you to put next to it? Do you feel like some people are doing more than others? There's a bot for that! Simply add the [chore-score-bot](https://t.me/ChoreScore_Bot) to your apartment's telegram group, track when people do chores and use the `/next` command to let the bot randomly assign a chore to someone who has done the least chores! [chore-score-bot](https://t.me/ChoreScore_Bot) also sports a vacation mode so that people enjoying their well-earned holidays aren't randomly yelled at to empty the trash can.
This is the backend for the .
[](license)
## Usage of the Bot
After adding the bot to your group, use `/add ` a couple of times to make the bot track scores for them. (The `` in no way has to correspond to any actual people in the group—Telegram bots aren't even allowed to see a list of group members.) When you've made a mistake, or someone moves out, use `/remove ` to stop tracking them.
Whenever someone does a chore, they or someone else should write `/give ` to record a point for that user. If they do something worth more than one point, you can do `/give `; the amount might be negative to subtract points.
If a chore needs doing, call `/next ` and the bot will pick a person with the lowest score randomly and also already give them a point—the bot assumes that people do the chore at some point. If the chore is worth more than one point, you can do `/next ` (If the first part after `/next` looks like a number, the bot will interpret it as an amount.) If everyone is on vacation (see below), the bot tells you.
The ``s might be any sequence of digits, possibly preceded by a sign.
The arguments to all commands must be separated by whitespace.
When someone is on vacation or can otherwise not fairly be expected to do chores right now, type `/vacation `. They will not be assigned chores for the time being and receive a fair share of all points other people receive, so that they will stay at the same amount of points relative to the group's average. When they return from vacation, simply type `/vacation ` again.
To see a table of everybody's scores and who is on vacation right now, use the `/scores` command. (Being on vacation is indicated in the table by a fun little emoji at the end of the line.)
| Command | Effect |
| ------------------------------ | ------------------------------------- |
| `/add ` | Start tracking score for _user_. |
| `/remove ` | Stop tracking score for _user_. |
| `/next ` | Assign the described chore to a random person with the lowest score, giving them _amount_ points for it. _amount_ might be left out, it defaults to 1. |
| `/give ` | Modifies _user_'s score by _amount_. _amount_ defaults to 1 if left out. |
| `/vacation ` | Toggle _user_'s vacation status. |
| `/scores` | Show a list of scores. |
## Usage of the Backend
(If you want to set up your own copy of this bot for some reason.)
1. Clone and install the repo:
```
git clone https://github.com/juliuste/chore-score-bot.git
cd chore-score-bot
npm install --production
```
2. Obtain a telegram token for your bot by contacting the `@BotFather` telegram account, and expose it as an environment variable named `TELEGRAM_TOKEN`.
3. Set up a MongoDB instance, expose an appropriate [MongoDB connection URI](https://www.mongodb.com/docs/manual/reference/connection-string/) as an environment variable named `MONGODB_URI`.
4. Store the name of the database the bot should use as the environment variable `MONGODB_DATABASE`. (Within that database, the bot will create a collection named `users` where it stores all its information.)
5. Run `npm start`.
## Contributing
For development and testing, you should of course drop the `--production` flag during installation. See the `package.json` for relevant npm scripts.
If you found a bug or want to propose a feature, feel free to visit [the issues page](https://github.com/juliuste/chore-score-bot/issues).