Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.79 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.79 KB
Raw

Scala IDE dashboard

This is a web application for displaying information about the projects under the Scala IDE umbrella. It is a Play application.

Importing the project in Eclipse

This is a Play/sbt project. To generate the files needed by Eclipse, launch sbt and use

eclipse with-source=true

More information about how to setup a Scala IDE environment for Play development is available in a tutorial.

Running the application

The application requires an OAuth token to connect to GitHub. The main usage is to go over the unauthenticated rate limit of the API (60 requests per hour max).

To create an OAuth token, go to your settings/applications page, and create a Personal Access Token. Then provides this token to the application as a Java properties parameter:

sbt -Ddashboard.oauthtoken=<oauth_token>

Deployment on Heroku

The GitHub OAuth is referenced in the Heroku config file as GH_OAUTH_TOKEN. The variable is set using:

heroku config:set GH_OAUTH_TOKEN=<oauth_token>

Support for websockets on Heroku is still experimental. It needs to be enabled with:

heroku labs:enable websockets

Otherwise, it is a normal Play application on Heroku.

Deployment for a different team

The main configuration file is conf/projects.conf. It contains the list of projects to display.

There are 3 categories supported by default: product, documentation and support. More can be used, and a css configuration created for them.

The other UI elements (logo, page title...) need to be changed in the templates.