https://github.com/june29/github-app-rails-example

A tiny GitHub App example built with Rails.
https://github.com/june29/github-app-rails-example

github-app rails ruby ruby-on-rails

Last synced: about 1 year ago
JSON representation

A tiny GitHub App example built with Rails.

• Host: GitHub
• URL: https://github.com/june29/github-app-rails-example
• Owner: june29
• Created: 2018-08-07T13:37:37.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-08-07T15:51:55.000Z (almost 8 years ago)
• Last Synced: 2025-04-06T17:50:20.521Z (about 1 year ago)
• Topics: github-app, rails, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 39.1 KB
• Stars: 4
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GitHub App example built with Rails

A tiny GitHub App example built with Rails.

## How to run

  1. Create your GitHub App on Register new GitHub App

    - Set `Webhook URL` to the server running this application

    - Set `Webhook secret` for security

    - Set `Read & Write` permission for `Pull requests`

  2. Create and configure `.env` file

    - Set `GITHUB_APP_IDENTIFIER` from your GitHub App

    - Set `GITHUB_WEBHOOK_SECRET` from your GitHub App

    - Set `GITHUB_HOST` optionally, if you use GitHub Enterprise

  3. Put `github-app.pem` on project root directory

    - Get from your GitHub App config page

  4. Run `rails server`

## References I read

- For GitHub

  - Building GitHub Apps | GitHub Developer Guide

  - Building Your First GitHub App | GitHub Developer Guide

  - platform-samples/api/ruby/building-your-first-github-app at master · github/platform-samples

  - Authenticating with GitHub Apps | GitHub Developer Guide

- For GitHub Enterprise (v2.14)

  - Authenticating with GitHub Apps | GitHub Developer Guide