https://github.com/statico/memorybot

🤖 An infobot-inspired Slack bot that remembers things
https://github.com/statico/memorybot

babel bot bots docker es6 infobot javascript node nodejs slack slack-bot slackbot sqlite

Last synced: 3 months ago
JSON representation

🤖 An infobot-inspired Slack bot that remembers things

• Host: GitHub
• URL: https://github.com/statico/memorybot
• Owner: statico
• License: mit
• Created: 2017-01-08T06:07:28.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T23:18:49.000Z (almost 2 years ago)
• Last Synced: 2024-07-19T11:17:24.380Z (4 months ago)
• Topics: babel, bot, bots, docker, es6, infobot, javascript, node, nodejs, slack, slack-bot, slackbot, sqlite
• Language: JavaScript
• Homepage: https://statico.github.io/memorybot/
• Size: 450 KB
• Stars: 15
• Watchers: 2
• Forks: 4
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![cute robot icon](https://statico.github.io/memorybot/icon.png)

# memorybot

[![Travis](https://img.shields.io/travis/statico/memorybot.svg?style=flat-square)](https://travis-ci.org/statico/memorybot)

[![issues](https://img.shields.io/github/issues/statico/memorybot.svg?style=flat-square)](https://github.com/statico/memorybot/issues)

[![Coveralls](https://img.shields.io/coveralls/statico/memorybot.svg?style=flat-square)](https://coveralls.io/github/statico/memorybot)

[![license](https://img.shields.io/github/license/statico/memorybot.svg?style=flat-square)](https://github.com/statico/memorybot/blob/master/LICENSE)

[![Docker](https://img.shields.io/docker/automated/statico/memorybot.svg?style=flat-square)](https://hub.docker.com/r/statico/memorybot/)

## How to use it

Check out the documentation on [https://statico.github.io/memorybot/](https://statico.github.io/memorybot/)

## How to install it

You will have to host and run memorybot yourself. There is no "Add to Slack" button because hosting bots costs money. Also, memorybot needs to listen to all of the chat messages on rooms you invite it to, so you probably don't want to send your Slack team's chat messages to some random server that you don't trust.

### 1. Create a new bot integration for your team

1. Go to [https://my.slack.com/services/new/bot](https://my.slack.com/services/new/bot)

1. Give it a nice name, like `@membot` or `@bender` or `@hal9000` or `@glados`

1. Maybe give it an icon. Check out the [free Robots Expression icons](https://www.iconfinder.com/iconsets/robots-expression) by Graphiqa Stock.

1. Save the API token for later. It should begin with `xoxb-`.

### 2a. Run memorybot with Docker

```

$ mkdir /path/to/data

$ docker run --name memorybot -v /path/to/data:/data -e SLACK_TOKEN=xoxb-xxxxx statico/memorybot

````

### 2b. Run memorybot as a standalone application

```

$ mkdir data

$ npm install

$ echo "SLACK_TOKEN=xob-xxxxx" >>.env

$ echo "DATA_DIR=data" >>.env

$ npm run -s start

```

## Feature requests & bugs?

Please [file a GitHub issue](https://github.com/statico/memorybot/issues) or [create a Pull Request](https://github.com/statico/memorybot/pulls).

## Credits

- [infobot](http://infobot.org/) is a project by kevin lenzo

- [Fun android icon](https://www.iconfinder.com/icons/385841/) by [Graphiqa Stock](https://www.iconfinder.com/graphiqa)