Skip to content

A Web app that will allow you to track the health of an open source project!

Notifications You must be signed in to change notification settings

ahamidi/OSS-health

Repository files navigation

Project Health

Open Source Project Health Monitor

Indicator of project health (i.e. is this project dead?)

Features

  • Accept Github repo and pull down metrics
    • Stars
    • Forks
    • Followers
    • Commit stats
    • Number of contributors
    • Issue stats
  • Calculate aggregate "health" or "activity" score
  • Persist scores (database)
  • Generate "badge" with score

Admin/Ops

  • Setup Github app credentials
  • Setup Heroku app
  • Travis CI
  • Automatically list "production" builds as releases
  • Good test coverage

Setup

  1. Get code: git clone https://github.com/140proof/OSS-health.git
  2. Get dependencies: go get -t
  3. Build: go build
  4. Run: ./OSS-health

Deploy (Heroku)

  1. Install Heroku Toolbelt
  2. Configure Heroku: heroku login
  3. Add Heroku App as Git Remote: heroku git:remote -a oss-health
  4. Deploy: git push heroku master

Notes: In order to deploy a different branch you must use git push heroku <other_branch>:master

Resources

About

A Web app that will allow you to track the health of an open source project!

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages