alwaysbegrowing/telegram-standup-bot

Very simple telegram bot for submitting daily standups

🤖 Stood Bot

A Telegram bot that helps you stay on track with daily updates! All members of a chat can participate and stay in the loop.

💡 How to use

1. Add @stood_bot to the chats you want to receive updates in.
2. Type /subscribe in each of those chats to start receiving updates.

🗓️ Schedule

• Reminders to submit updates sent at 10AM EST.
• Updates posted at 11AM EST.

🔧 Support

If you're having trouble with the bot, feel free to create a GitHub issue.

🛠️ Self-Hosting Setup

1. Install Vercel CLI: yarn global add vercel
2. Set up the project with Vercel: vercel deploy (accept all default settings)
3. Create a Telegram bot with BotFather: https://core.telegram.org/bots#6-botfather
4. Add your Telegram bot API key as an environment variable: vercel env add TELEGRAM_API_KEY
5. Create a database instance with MongoDB Atlas (name your database "standup"): https://www.mongodb.com/cloud/atlas
6. Add your MongoDB URI as an environment variable: vercel env add MONGODB_FULL_URI
7. Pull down the environment variables as a local .env file for local development: vercel env pull
8. Set up a webhook to your Vercel standup URL: https://api.telegram.org/bot${TELEGRAM_API_KEY}/setWebhook?url=https://.../api/standup?key=${TELEGRAM_API_KEY}

💻 Local Development

yarn
vercel dev

This runs the website at localhost:3000 and runs your Lambda functions in the /api folder on localhost:3000/api. For more information, check out Vercel's Serverless Functions Introduction.

🔎 Troubleshooting

If your messages or commands aren't going through, check for any pending updates and read the error. You may have to fix the error, or it will happen again.

https://api.telegram.org/bot${TELEGRAM_API_KEY}/getWebhookInfo
https://api.telegram.org/bot${TELEGRAM_API_KEY}/deleteWebhook?drop_pending_updates=true

To view your function logs in Vercel, log in to Vercel, navigate to your bot, click on your functions, and then view the function logs.

telegram-standup-bot's Issues

still notifies you on update send

i thought doing disable_notification would resolve this but it hasn't, my phone still gets a notification for every group i'm in

maybe remove the @mention entirely and just keep first name? the con is that it would be hard to find peoples responses i think

locked shows message too far if its too early

haveo to check if hour < submitHour

Undefined Name in Winner Message

Describe the bug
The winner message outputs a very unfriendly message seen below 😢

To Reproduce
Steps to reproduce the behavior:

1. Make an account without a username set
2. Create a new channel that only you are in
3. Subscribe to stoodbot events
4. Be "randomly" chosen
5. View error

Expected behavior
The bot should address the person's first & last name if there is not a username given

Screenshots

"one hour from now" don't hardcode 11am

use server time to add +1h and convert to EST ?

Add text box to submit your own update at the top (will be useful for me when I start using TG less in a month)

Updates should be in reverse order (desending)

UI piece is AWESOME let's make it even better

Thoughts I had:

• Show most recent unlocked update by default without having to expand the accordion
• #49
• What happens after 30 days of updates? The accordions will be miles long
• #47

Other notes:

• There are back-ticks around all of the messages

WHich bot for Users?

How do you want to handle which bot we have people use / market? I don't really care - but the main one should be kept up to date with CI

Also - sad - https://stackoverflow.com/questions/44927298/change-telegram-bot-owner :(

Pause reminders does not work

Add ability to submit update through web UI

@SvenWritesCode Any thoughts on how to do this? We could just call the webhook URL and impersonate a telegram message.

Github team or leave on this repo?

https://github.com/pricing we can have team for free but there r some limitations. My acc has pro (and 20 stars on this repo already :) )

Might be able to get some open source github thing as well?

The bot seems to not have triggered for today

Is it a holiday I am not aware of?

last one was from yesterday and it's after 11 AM EST

make photos open in modal zoom

to better see the photo

Enhancement: command to disable reminders

It would be a nice feature to be able to disable the daily reminders about submitting stand ups.

Add "submitted" flag to each update in updateArchive

This way you know which update was the final draft & sent to the whole group

Right now all submissions are just logged without knowing which one was sent

Can't use optional chaining

Nodejs 14+ is required for optional chaining.

Vercel only supports v10 and v12 - https://vercel.com/docs/runtimes#official-runtimes/node-js/node-js-version

They won't be able to support v14 until it is supported by AWS - https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html

Allow multiple messages for a single update

Right now, I submit a piece of text and then submit a photo. The photo is all that sends. I would like for the update to accept all messages up to some reasonable max.

Upon first message say:
Awesome, thanks for the update. I will send this out at 11, but before then, feel free to add more to the update by sending me another message, view and edit your update by pressing the buttons below.

There will be a view button that takes the user to their update draft on the web interface.

There will be an edit button that takes the user to the edit interface on the web.

A Start Over? button can be pressed to remove the whole update after a confirmation. The bot will say

A great idea to start over, some of the best ideas come from writing down thoughts multiple times.

Upon sending another message, the bot respond with:

Great. Got your additions! View or edit your updated update below.

Lots of empty updates?

reactions trigger update

Describe the bug
Reactions on old messages re-trigger bot as if they were sent by the author.

To Reproduce
Steps to reproduce the behavior:

1. React to a previous command in the chat
2. Observe stood bot responding to it.

Expected behavior
Reactions have no effect on stood bot.

Screenshots

Setup new Vercel Acc

https://vercel.com/teams/alwaysbegrowing/settings/members

@Geczy and @SvenWritesCode are current members. Team is usable and on pro trial for 14 days. (Should then be extended forever when vercel sponsors us)

We need to setup the env variables on the new vercel acc and make the domain @Geczy bought is linked to this vercel acc

names send out of order

names should show who sent the update , it comes out of order

Update to next v12

https://nextjs.org/blog/next-12

command to show what groups you're in

and maybe hyperlink the output to take you to the group with a click

save profile pic to each user

right after login

Add TG bot to telegram directories

If we want users it'd probably be worthwhile to submit the bot to several of the popular TG bot aggregators out there. (Sadly TG doesn't have its own!)

integrate ngrok with dev script

and automatiaclly call the setwebhook function to the ngrok domain

Messages are delivered in the wrong order

Implement Pagination for /view endpoint

/view endpoint currently returns ALL of the past updates. I plan to use this bot for YEARS which means every single day the data returned by /view will increase and increase

Explore CMS solutions

Wordpress?

Plugin to auth with telegram

Plugin to post your blog posts to your telegram groups

All of these exist already and it seems to be the direction we're going

don't verify signature every api request

this is expensive and it runs way too often

we should cache the signature against the hash either in the db or in memory

captions don't show on ui for group photos

Make lottery less random

A request for a less random picker was brought up after some people out of a group of 15 participants have yet to be picked in the past two months.

Describe the solution you'd like
Have a new list of weights per participant. the weights can start proportionally and when a person is chosen, their weight is cut by 3/4 and their weight is evenly distributed to the other participants. When a new participant joins, weights are adjusted to allow the newcomer a starting proportional weight.

Describe alternatives you've considered
to start - make sure a person isn't chosen twice in a row by filtering out the previous winners.

telegram-standup-bot/pages/api/lib/_lottery.ts

Line 18 in 805c853

await unsetWinners();

Additional context
Maybe something like this? https://www.npmjs.com/package/random-weighted-choice where everyone but the winner's weight is increased by 1? and newcomer weight is the average of all weights?

locked ago has wrong time

looks like its checking 11am today instead of tomorrow

allow bold/italics/links via text "entities"

can only send plaintext

command to pause / resume reminders

the escape entities function is buggy

a link looks like this

<a href="https://goo%5C.gl/maps/og5VWJCBoF1qyXsx6">https://goo\.gl/maps/og5VWJCBoF1qyXsx6</a>

i think links shouldn't run the escape function, and rather just convert immediately to markdown

https://github.com/alwaysbegrowing/telegram-text-entities-filler

Remove groups that the bot can't access anymore

Describe the bug

The bot will still roll for you in groups it doesn't exist

To Reproduce
Steps to reproduce the behavior:

1. Add it to a group
2. Remove it from the group
3. Still get a lottery message

Users with privacy settings hiding profile photo see no updates

Describe the bug
When viewing the update page as a logged in user, there are no updates shown.

To Reproduce
Steps to reproduce the behavior:

1. Set Profile Photo in "Privacy and Security" to "My Contacts"
2. Maybe log out and log back in?
3. Observe no updates

Expected behavior
Updates are shown

Add /clear command

Is your feature request related to a problem? Please describe.

I'm always frustrated when I have updates queued up, but I can't delete one

Describe the solution you'd like

Delete an update in the chat to prevent it from posting

Describe alternatives you've considered

/clear to delete all pending updates

Additional context

There's no event on deleting a message in a bot DM :( which makes native deletion hard but not impossible (can check if the msg id exists still / is viewable before it sends)

Hide not setup message on first login

Enable / disable update lottery system

One person a week per group will get picked to post an update for Friday

/enablelottery

/disablelottery

Maybe enable / disable command per the group you're in? That way you can pick which groups should get the lottery and which ones get the daily update, rather than an all or nothing setting

Allow album updates

Multiple photos and videos and one caption

Allow edits and deletes

To a message you send the bot

Improve Instructions

Yes but it seems like it would just remind me to post it myself (I only thought otherwise because I saw it post on your behalf)

Add info about how to edit message in DM'd help

Is your feature request related to a problem? Please describe.
More info about how stoodbot updates would give users more confidence on how it will work and output.

Describe the solution you'd like
A help command or reminders when someone posts a lot of updates, "remember you can edit your previous messages and I'll send the updated version" or a way to preview and erase the update to start over.

Describe alternatives you've considered
Telling the person myself how it works. That doesn't solve the problem for everyone and makes me do extra work.

Additional context

Hide the most recent update until it's actually time to post

Choose groups to get your update submission in web ui

Really starting to sound like wordpress lol

Telegram login button replacement

Don't use telegram api to load the button it's too slow

Or maybe load it sooner in the document

See if you can wrap it with a geist button

Fine tune control over reminders

itd be cool to control the reminders it sends. i think ideally i want to be reminded to send an update at random intervals throughout the week. maybe a simple algorithm where each day there is a 14% chance i get a reminder. that way, ill get a reminder on average once a week.

Perhaps a week picker with time

Don’t mention user when posting update

I do not like being @ mentioned by the bot and do not see a strong reason why I should be alerted to it. I already wrote it. I know about the message.