Skip to content

Commit f203186

Browse files
author
Tom Osowski
authored
Add README documentation
1 parent 4b6092b commit f203186

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

app/ruby/app-issue-creator/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# app-issue-creator
2+
3+
This is the sample project that walks through creating a GitHub App and configuring a server to listen to [`installation` events](https://developer.github.com/v3/activity/events/types/#installationevent). When an App is added to an account, it will create an issue in each repository with a message, "added new app!".
4+
5+
## Requirements
6+
7+
* Ruby installed
8+
* [Bundler](http://bundler.io/) installed
9+
* [ngrok](https://ngrok.com/) or [localtunnel](https://localtunnel.github.io/www/) exposing port `4567` to allow GitHub to access your server
10+
11+
## Set up a GitHub App
12+
13+
* [Set up and register GitHub App](https://developer.github.com/apps/building-integrations/setting-up-and-registering-github-apps/)
14+
* [Enable `issue` write permissions](https://developer.github.com/v3/apps/permissions/#permission-on-issues)
15+
* If not running on a public-facing IP, use ngrok to generate a URL as [documented here](https://developer.github.com/v3/guides/building-a-ci-server/#writing-your-server)
16+
17+
## Install and Run project
18+
19+
Install the required Ruby Gems by entering `bundle install` on the command line.
20+
21+
To start the server, type `ruby server.rb` on the command line.
22+
23+
The [sinatra server](http://www.sinatrarb.com/) will be running at `localhost:4567`.
24+
25+
[basics of auth]: http://developer.github.com/guides/basics-of-authentication/

0 commit comments

Comments
 (0)