Skip to content

Update README.md #45

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
kanav99 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #45

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
35 changes: 24 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
bot
===
# bot

bot is our friendly robot that sits on sdslabs chat and helps us in lots of things.
It is powered by Hubot (by GitHub), and uses some custom scripts as well.
bot is our friendly robot that sits on SDSLabs Slack and helps us in lots of things.
It is powered by Hubot (by GitHub), and have been personalized for our use case.

This is hosted on the heroku free tier, and we use jsonblob.com as the brain storage
service.
This is hosted on the Heroku Free tier, and we use https://github.com/sdslabs/botdb as the brain storage
service. This can be changed to use https://jsonblob.com too (`botdb` and JSON Blob use the same API endpoints).

Set-up Instructions
===================
## Set-up Instructions

After cloning repository, run the following command in the terminal:
1. Setup [botdb](https://github.com/sdslabs/botdb) using the setup instructions.

JSONBLOB_URL="{JSONBLOB_URL}" INFO_SPREADSHEET_URL="{INFO_SPREADSHEET_URL}" bin/hubot
2. Clone this repository at your desired location

The config variables can be found from the heroku account.
```bash
git clone https://github.com/sdslabs/bot
cd bot
```

3. Prepare a Google Sheet using this template and enable link sharing

@sin3point14 sin3point14 Mar 24, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which template?


4. Setup environment variables

```bash
export JSONBLOB_URL="http://localhost:5050/"

@twaritwaikar twaritwaikar Mar 23, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we also need a HUBOT_SLACK_TOKEN?

@sin3point14 sin3point14 Mar 24, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to this

export JSONBLOB_TOKEN="token_set_in_botdb"
export INFO_SPREADSHEET_URL="csv_export_url_of_link"
```

5. Run the bot for testing using `./bin/hubot`