From 0d7b28913035b37d2caf0024a65c281f4376b149 Mon Sep 17 00:00:00 2001 From: Chris Castle Date: Mon, 15 Jan 2018 17:35:36 -0800 Subject: [PATCH] Add Deploy to Heroku button --- Procfile | 1 + README.md | 4 ++++ app.json | 21 +++++++++++++++++++++ 3 files changed, 26 insertions(+) create mode 100644 Procfile create mode 100644 app.json diff --git a/Procfile b/Procfile new file mode 100644 index 0000000..15c00c9 --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: java -jar -Xmx256M ./target/github-profile-summary-jar-with-dependencies.jar diff --git a/README.md b/README.md index aea3276..85a8666 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,7 @@ You can enable Google Tag Manager on your instance by setting `gtm-id`: * `docker run -it --rm --name github-profile-summary -p 7070:7070 github-profile-summary` * OR with a token `docker run -it --rm --name github-profile-summary -p 7070:7070 -e "API_TOKENS=mytoken1,mytoken2" github-profile-summary` * browse to http://localhost:7070 + +## run on Heroku (for free) + +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) diff --git a/app.json b/app.json new file mode 100644 index 0000000..0c1f8df --- /dev/null +++ b/app.json @@ -0,0 +1,21 @@ +{ + "name": "GitHub Profile Summary", + "description": "Tool for visualizing GitHub profiles", + "website": "https://github-profile-summary.com/", + "repository": "https://github.com/tipsy/github-profile-summary", + "env": { + "API_TOKENS": { + "description": "If no api-token is set, you only get ~50 requests/hour. Generate a token at https://github.com/settings/tokens, and input here. You can use a comma-separated list of tokens to increase your rate-limit.", + "required": false + }, + "UNRESTRICTED": { + "description": "Allow profile summary to be built for any GitHub profile. Summary creation of large profiles can quickly consume your API request limit.", + "required": false, + "value": "false" + }, + "GTM_ID": { + "description": "Provide a Google Tag Manager ID to enable GTM.", + "required": false + } + } +}