Skip to content
This repository has been archived by the owner on Nov 14, 2018. It is now read-only.

danmayer/churn-site

Repository files navigation

churn-site

A app to calculate and display code churn on a project.

This is a web front-end and hooks that trigger builds, but all the data is powered by the churn gem

It displays data like:

  • total files with churn above threshold
  • avg file, class, and method churn
  • the number of files over the avg file, class, and method churn
  • churn increase over time

Build Status

To Run Examples Locally

foreman start
#or
bundle exec rackup -p 3000
#or with dev procfile for shotgun reloading
foreman start -f Procfile.dev -e .env.development
#or local with production data (make sure redis and other env vars are set)
RACK_ENV=production foreman start -f Procfile

Console

#local console
bundle exec script/console

#heroku remote console in production more
heroku run script/heroku-console

Api Docs

The documentation for the churn api can be found at churn api docs.

TODO

Contributing

  1. Fork it.
  2. Create a branch (git checkout -b my_markup)
  3. Commit your changes (git commit -am "Added something awesome, it does X which solves problem Y")
  4. Push to the branch (git push origin my_markup)
  5. If you haven't already read about good Pull Request practices or have never submitted one before read about submitting your first pull request
  6. Open a Pull Request
  7. Awesome thanks I will try to get back to you soon.

Thanks

MIT License

See the file license.txt for copying permission.

Generated by Sinatra Template

This project was originally generated by sinatra template

About

A webapp to host and view churn metrics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published