Skip to content
This repository has been archived by the owner on May 22, 2023. It is now read-only.

Latest commit

 

History

History
72 lines (52 loc) · 2.56 KB

heroku.md

File metadata and controls

72 lines (52 loc) · 2.56 KB
Raw

Heroku Deployment

gbf-raidfinder runs comfortably on Heroku's free tier, for about ~5000 concurrent users. After the 5.5k user mark, performance starts to degrade, due to Heroku's router not being able to keep up.

The app needs Twitter API credentials to connect to the streaming API. You can create a new app at apps.twitter.com (You can enter whatever name/description/website you want, it doesn't actually matter). After you have an app, check the "Keys and Access Tokens" tab, and generate your access token/secret.

Although Heroku is free, it's recommended to add a credit card so Heroku allows your application to run 24/7 (you won't be charged).

Quick Deploy

Deploy

You can click the image above to deploy the current code in this repository to Heroku. This will compile and run the app (it may take several minutes to build the first time), and add Redis Cloud for persistence.

Manual Deploy

gbf-raidfinder uses sbt-heroku for manual Heroku deployment. To run your own instance, you will need to set some environment variables and enable Redis Cloud.

  • Clone the repository and add Heroku as a remote:

    git clone https://github.com/walfie/gbf-raidfinder.git
cd gbf-raidfinder
heroku git:remote -a your-heroku-app-name-here

  • Set Twitter credentials:

    heroku config:add oauth.consumerKey=****************
heroku config:add oauth.consumerSecret=****************
heroku config:add oauth.accessToken=****************
heroku config:add oauth.accessTokenSecret=****************

  • Add the Redis Cloud add-on to your project, either on the website or using the command below:

    heroku addons:create rediscloud:30

Then, you can either use the usual git push heroku master workflow (the app will be compiled on Heroku), or build it on your own computer and push the compiled artifacts using sbt as shown below:

  • Change the following line in /build.sbt to point to your application name (not "gbf-raidfinder")

    herokuAppName in Compile := "gbf-raidfinder",

  • Run sbt stage deployHeroku

Troubleshooting

If it deploys successfully but no bosses show up when you visit the site, check the Heroku logs for the app for any errors. It's most likely due to incorrectly configured Twitter API keys, so double-check that you've entered the correct keys.