Giter VIP home page Giter VIP logo

slackengine's Introduction

SlackEngine

Enable public access to your Slack server!

This is a (partial) clone of slackin for Google App Engine.

It provides

  • A landing page you can point users to fill in their emails and receive an invite
  • A free https://.appspot.com domain name!

Why App Engine?

Most slack inviters require you to run a server 24/7 to work. However, most users will visit the app once and never come back to it!

With App Engine, you can run your slack inviter with the App Engine free tier and never worry about it again! If your community starts to recieve a lot of traffic, App Engine will automatically scale to handle the load as well.

Slackin is my favorite slack inviter, but won't run on App Engine without using custom runtimes. So SlackEngine was born!

How to use

Setup

  • Install the App Engine SDK for PHP if you don't have it.
  • Visit the Google Developers Console, and create a new project.
  • Visit reCAPTCHA, and register your website.
  • Install reCAPTCHA library with Composer
    • run composer install
  • Edit app.yaml
    • Replace <PROJECT-ID> with the project ID you just created
  • Edit constants.php
    • Replace <YOUR-SUBDOMAIN> with your team's slack subdomain (i.e If your slack is myteam.slack.com, your subdomain is 'myteam').
    • Replace <YOUR-API-TOKEN> with your slack API token
      • You can find your API token at api.slack.com/web
      • Note that the user you use to generate the token must be an admin.
      • You should create a dedicated @slackin-inviter user (or similar), mark that user an admin, and use a token from that dedicated admin user.
      • Replace <YOUR-reCAPTCHA-SECRET> with your reCAPTCHA secret
      • Replace <YOUR-reCAPTCHA-SITEKEY> with your reCAPTCHA site key
      • Replace <YOUR-NOTE> with a small note you want to display
  • Launch your app:
    • Run appcfg.py update app.yaml .

Credits

  • The look and feel is heavily inspired by slackin
  • The decision to use PHP was inspired by this gist

License

All code is licenced under Apache v2

Note: This is not an official Google product.

slackengine's People

Contributors

thesandlord avatar neojato avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.