Skip to content
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.

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

Readme edits #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,30 @@
# Health Buddy Slack app
Health Buddy is a Slack App that helps you maintain mental and physical health throughout the day by sending periodic reminders and uplifting messages.

Health Buddy is a Slack App that helps you maintain mental and physical health throughout the day by sending periodic reminders and uplifting messages.

## Sources used
- Slack API documentation https://api.slack.com/
- How to write a slack bot with python code https://medium.com/@julianmartinez/how-to-write-a-slack-bot-with-python-code-examples-4ed354407b98
- Slack developer kit https://slackapi.github.io/python-slackclient/

- [Slack API documentation](https://api.slack.com/)
- [How to write a Slack bot with Python code](https://medium.com/@julianmartinez/how-to-write-a-slack-bot-with-python-code-examples-4ed354407b98)
- [Slack developer kit](https://slackapi.github.io/python-Slackclient/)

## How to install on your own Slack channel
- First things first, you need to create a folder to hold all of these files and set up a virtualenv. You can do this by opening your terminal and navigating into the project folder. Then just install the virtualenv with this code: `--python=/Users/username/Software/Python-3.6.0/mybuild/bin/python3 env`. To activate, use: `source env/bin/activate`.

- First things first, you need to create a folder to hold all of these files and set up a virtualenv.
- Next, you must install Slack Developer Kit for Python. Do that by typing `pip install slackclient` in the command line.
- Then you must open slack in your browser, and retrieve the slack channel ID, located in the URL. Paste that into "channel."
- After that, generate your own slack token. To read about different slack tokens, visit https://api.slack.com/docs/token-types. You need the Oauth Bot User Token.
- Invite health-buddy to the slack channel!
- If you want, you can add more messages into JSON file.
- Finally, deploy to Heroku. Here's is a helpful video we used: https://www.youtube.com/watch?v=DwWPunpypNA. We also used Heroku Scheduler to have Health Buddy run every four hours.
- Then you must open Slack in your browser, and retrieve the Slack channel ID, located in the URL. Paste that into "channel."
- After that, generate your own Slack token. [Read about different Slack tokens.](https://api.slack.com/docs/token-types) You need the OAuth Bot User Token.
- Invite health-buddy to the Slack channel!
- If you want, you can add more messages into the *tips.py* file.
- Finally, deploy to Heroku. [Here is a helpful video we used.](https://www.youtube.com/watch?v=DwWPunpypNA) We also used Heroku Scheduler to have Health Buddy run every four hours.
- You're good to go!

## Questions, comments, concerns?

- Gabrielle Calise
- [Github](https://github.com/gabriellecalise)
- [Github](https://github.com/gabriellecalise)
- [Twitter](https://twitter.com/gabriellecalise)

- Mary-Lou Watkinson
- [Github](https://github.com/M-Watkinson)
- [Twitter](https://twitter.com/Mary_Lou_W)