Skip to content

Commit

Permalink
Update README docs on how to set up locally
Browse files Browse the repository at this point in the history
Update .env.example
  • Loading branch information
angelocordon committed Mar 6, 2018
1 parent fa963e3 commit 962f651
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .env.example
@@ -1,4 +1,4 @@
SLACK_TOKEN=slacktoken
SLACK_VERIFICATION_TOKEN=slacksecret
SLACK_TOKEN=
SLACK_VERIFICATION_TOKEN=
PORT=3000
DEV_SUBDOMAIN=yourname
DEV_SUBDOMAIN=janefoster
25 changes: 22 additions & 3 deletions README.md
@@ -1,5 +1,5 @@
# Greetbot
Greetbot is a Slackbot app built with [ExpressJS](https://expressjs.com/) to be used with the [Codebuddies](https://www.codebuddies.org) open Slack community. Greetbot helps us welcome and onboard new members and provide valuable coding resources.
# greetbot
greetbot is a Slack app built with [ExpressJS](https://expressjs.com/) to be used with the [Codebuddies](https://www.codebuddies.org) open Slack community. greetbot helps us welcome and onboard new members and provide valuable coding resources.

## Contributing
### Code of Conduct
Expand All @@ -8,7 +8,26 @@ This is an open source project and we welcome all developers of all skill levels
**TL;DR:** Be nice, we are all here to learn together.

### Development
Please refer to our [wiki](https://github.com/codebuddies/greetbot/wiki) for guides on getting set up, development workflows and testing.
Development contribution requires that you have your own Slack workspace as your sandbox for local development purposes. For instructions on how to make your own, see Slack's [tutorial](https://get.slack.help/hc/en-us/articles/206845317-Create-a-Slack-workspace).

#### Getting Started
1. Install dependencies with NPM
```bash
npm install
```

2. Create an `.env` file by following the same structure as `.env.example`. Change the `DEV_SUBDOMAIN` variable to your name without spaces. For example, if your name is Jane Fonda, then the `DEV_SUBDOMAIN` value should be `janefonda`.

3. Run Development mode
```bash
npm run start:dev
```

#### Installing greetbot in your sandbox workspace
We have created a guide on how to set up your local version of greetbot in your Slack workspace. Read it [here](https://github.com/codebuddies/greetbot/wiki/Setup-Greetbot-in-your-Slack-Workspace).

#### Putting it all together :tada:
Now that you have followed the tutorials and guides linked above to a T (right??), greetbot should work in your slack workspace. Try sending a slash command by typing `/welcome test`. greetbot should send you private message with a welcome message.

### Feature Requests / Ideas / Issues
For bugs or other issues, feel free to file an [Issue](https://github.com/codebuddies/greetbot/issues).
Expand Down

0 comments on commit 962f651

Please sign in to comment.