Skip to content

fix: Add documentation of how to set this up #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: Add documentation of how to set this up #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,11 @@ Makes use of [node-slack-client](https://github.com/slackhq/node-slack-client).
3. Run `npm install`
4. Go to `index.js` and update `BOT_TOKEN`, `REPO_OWNER`, and `REPO_NAME`
5. Run `node index.js`

## Raspberry Pi Setup
For a complete guide on setting up this bot on a Raspberry Pi, check out the documentation in this [similar Slack app](https://github.com/augbog/slack-soundcloud-pulse).

To run the bot on a Pi and keep it alive after disconnecting:
1. Install Node.js and npm on your Pi.
2. Clone this repo, run `npm install`, and update the configuration in `index.js`.
3. Start the bot using `screen` or `tmux` (e.g., `screen -d -m -S slack-bot node index.js`), or set it up as a background service to run on boot.