BookmarkMe

BookmarkMe is a GroupMe chatbot that allows you to bookmark messages for future reference. It is a simple Flask app deployed to Heroku and uses MongoDB for saving bookmarks.

The bot supports the following commands. These descriptions follow the default command names but you can customize them when you deploy the bot. You run these "commands" just by sending them as messages in the chat.

The :save command allows you to save/bookmark messages. Probably the most important command.

• :save will try to save the last message that was "stored". The bot stores every message that was sent in the group for the next 24 hours (after which the messages are deleted). When the bot is newly added to the chat, it has no messages to store.
• :save <text> will find the last stored message that contains the specified text. For example, if "IMPORTANT MESSAGE" was the text of the message previously sent, then typing :save IMPORTANT should be enough to bookmark it.
• :save "<text>" will store the text between the double quotes verbatim. For example, typing :save "MORE IMPORTANT MESSAGE" will bookmark "MORE IMPORTANT MESSAGE".

You can view all saved bookmarks by typing :all but that would spam the group, so you can use the :show command.

• :show will try to display the most recently saved bookmark.
• :show <text> will display the bookmark containing the specified text. For example, typing :show IMPORTANT after storing the two examples above will display "MORE IMPORTANT MESSAGE"

If you don't need a bookmark anymore, you can delete it by using :delete <text> following a similar format to the examples above.

There are a few simple steps involved here.

1. Deploy the app to Heroku using the button below. Give it a memorable app name; we will need it later. (You'll see a temporary BOT_ID but we will change that later.)

   

2. Create a bot user at the GroupMe dev site. Assign it to the chat you want to add it, give it a name and an [optional] avatar, and for the callback URL, use https://<app-name>.herokuapp.com where <app-name> corresponds to the app name you used in step #1. Also remember the name you used for your bot.

3. Now copy the "bot ID" field on the GroupMe dev site.

4. Go to your app dashboard on Heroku (clicking "Manage" when the install finishes in step #1) and in the settings tab, change the config variable BOT_ID from default to the value you copied in step #3.

5. You can change the default values of the other variables in the list if you want. BOT_NAME is the name of the bot, and the others are commands to trigger the bot. Make sure the BOT_NAME is the same as what you entered on the GroupMe dev site in step #2.

6. Once you're done creating the Heroku instance, you just need to attach a database to it. Create a config var (in Heroku settings) with MONGODB_URI as the key and your database url as the value. It's upto you which MongoDB service you want to use but the official MongoDB Atlas might be good enough.

The MIT License