Giter Club home page Giter Club logo

smee's Introduction

smee ยท Build Status Codecov

smee is a web application that receives payloads then sends them, via the EventSource API, to other clients.

How it works

  1. Go to https://smee.io/new, which will redirect you to a randomly generated channel. You must be using a browser that supports Server-Sent Events.

  2. Use that new page's URL as your App's Webhook URL

  3. Use the client to proxy events and send them to a path on your local device, or set it as your Probot App's WEBHOOK_PROXY_URL environment variable.

  4. Watch events come in to the web UI

  5. Profit!

Motivation

One of the most cumbersome parts of building a GitHub App with Probot is dealing with webhook deliveries. When working locally, for your app to receive webhooks you'd need to expose it to the internet - that's where we've used localtunnel. However, it's not very reliable or fast and is more than many apps need to simply collect webhook events.

This also gave us a way to build our own UI around the needs of a Probot App. Together with the GitHub App UI, we now have a better way to get the full picture of what goes on in an app in development.

Setup

# Install dependencies
npm install

# Run the server
npm start

smee's People

Contributors

jasonetco avatar bkeepers avatar tcbyrd avatar knrt10 avatar mrchrisw avatar zeke avatar

Watchers

James Cloos avatar Radoaslav Nedyalkov 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.