Browse Source

Clarified deployment vs. development.

master
dblock 9 years ago
parent
commit
b0091ac6d0
3 changed files with 24 additions and 22 deletions
  1. +23
    -9
      CONTRIBUTING.md
  2. +1
    -1
      DEPLOYMENT.md
  3. +0
    -12
      README.md

+ 23
- 9
CONTRIBUTING.md View File

@ -16,23 +16,37 @@ cd slack-mathbot
git remote add upstream https://github.com/dblock/slack-mathbot.git
```
## Create a Topic Branch
## Bundle Install and Test
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
Ensure that you can build the project and run tests.
```
git checkout master
git pull upstream master
git checkout -b my-feature-branch
bundle install
bundle exec rake
```
## Bundle Install and Test
## Run SlackMathbot in Development
Ensure that you can build the project and run tests.
Create a private slack group for yourself.
Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
![](screenshots/register-bot.png)
On the next screen, note the API token.
Run `SLACK_API_TOKEN=<your API token> foreman start`.
You can also create a `.env` file with `SLACK_API_TOKEN=<your API token>` and just run `foreman start`.
## Create a Topic Branch
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
```
bundle install
bundle exec rake
git checkout master
git pull upstream master
git checkout -b my-feature-branch
```
## Write Tests

+ 1
- 1
DEPLOYMENT.md View File

@ -22,7 +22,7 @@ heroku config:add SLACK_API_TOKEN=...
#### GIPHY_API_KEY
Slack-Gamebot replies with animated GIFs. While it's currently not necessary, uyou may need to set GIPHY_API_KEY in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details.
Slack-Gamebot replies with animated GIFs. While it's currently not necessary, you may need to set GIPHY_API_KEY in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details.
### Heroku Idling

+ 0
- 12
README.md View File

@ -9,18 +9,6 @@ A math bot for Slack.
## Installation
Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
![](screenshots/register-bot.png)
On the next screen, note the API token.
Run `SLACK_API_TOKEN=<your API token> foreman start`
While it's currently not necessary, uyou may need to set _GIPHY_API_KEY_ in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details.
## Production Deployment
See [DEPLOYMENT](DEPLOYMENT.md).
## Usage

Loading…
Cancel
Save