sarbbottam / checkup

A health checkup for your project.

Checkup: A health checkup for your project

Checkup aims to provide you with insights into your codebase. You can track the progress of your codebase for things such as:

1. Insights
   • types of code constructs used (types, etc)
   • dependency health
   • test type breakdown (unit, integration, functional, visual, etc)
2. Migrations
   • chart the progress of active code migrations to help you get a sense of progress
3. Recommendations
   • suggested areas of improvement

This allows you to have a more full, high level view of your codebase at any one point in time. Checkup can help you with making resourcing decisions, planning and prioritizing the general health of your codebase.

What you get with Checkup

Checkup provides you with a CLI, which can be run against your code base. Using a custom Checkup configuration file, plugins can be configured and loaded containing tasks to run. The CLI will execute these tasks on your codebase, ultimately aggregating and producing a comprehensive Checkup report.

Usage

See the CLI README for information on usage.

Spec

Read more about the mission, vision, and overall direction of checkup in the spec document.