README.md

Slack Community Inviter/Landing Page

A simple application, to help bootstrap your slack community.

Setup

1. Signup for a slack team on their homepage(https://slack.com/)

• Go through the entire process.
• visit https://api.slack.com/web#authentication and get a token! (easy way to turn off invitations is by revoking the token!)

2. Publish this app, add your configurations.

3. Submit your heroku url to https://keep-awake.herokuapp.com/ - add _ping for optimal performance (eg http://example.herokuapp.com/_ping )

Usage

POST /invitations

To enqueue an invitation request:

curl -X POST \
  -H "Content-Type: application/json" \
  -d "{\"email\":\"andy@example.com\"}" \
  http://localhost:3000/invitations

The route is meant to be used by a JavaScript client. You can whitelist CORS origins in config/application.rb.

Development

clone bundle rename .env file

mv .env.example .env

edit variables

SIDEKIQ_USERNAME=user
SIDEKIQ_PASSWORD=password
SLACK_TOKEN=yourslackapitoken
SLACK_SUBDOMAIN=yourslacksubdomain
TITLE="Title of your slack community?"
TOP_SUBTITLE="Come make some friends, share links, meet a lunch buddy."
BACKGROUND_IMAGE="http://i.imgur.com/vDADTWP.jpg"

start the server

rails s

Prerequisites

• PostgreSQL: brew install postgresql
• Redis: brew install redis

Required Configuration

Configuration items are stored in environment variables.

SIDEKIQ_USERNAME=user
SIDEKIQ_PASSWORD=password
SLACK_TOKEN=yourslackapitoken (an API token for an administrator of the organization from: https://api.slack.com/web)
SLACK_SUBDOMAIN= e.g., tech404 for tech404.slack.com (signup for slack)
TITLE="Title of your slack community?"
TOP_SUBTITLE="Come make some friends, share links, meet a lunch buddy."
BACKGROUND_IMAGE="http://i.imgur.com/vDADTWP.jpg"