Archived Repository The code of this repository was written during a Hack Day by a Marmelab developer. It's part of the distributed R&D effort at Marmelab, where each developer spends 2 days a month for learning and experimentation. This code is not intended to be used in production, and is not maintained.

Gizu

Gizu is visualization tool for Git. It computes a CLOC on all the commits of a project and displays the results into a treemap representation with help of d3.

Installation

Install dependencies :

  npm install
  bower install

Create a config file :

  cp app/scripts/services/config.js.dist app/scripts/services/config.js

Create a Dataset

Before starting Gizu you need to create a dataset for your git repository :

  grunt git-import --repository=YOUR_GIT_REPOSITORY

For example, YOUR_GIT_REPOSITORY could be git@github.com:fzaninotto/uptime.git.

You can also use the --step option if you don't want to process every commits :

  grunt git-import --repository=YOUR_GIT_REPOSITORY --step=5

5 commits will be skipped between each CLOC.

Configuration

You can exclude files from the treemap. Go into your config file app/scripts/services/config.js and add paths to exclude (all paths have to be prefixed by ./).

For example :

  'use strict';
  angular.module('gizuApp')
    .constant('config', {
      exclude: [
        './vendors/jquery.min.js',
        './public'
      ]
  });

Usage

To run the app, just start it with Grunt :

  grunt serve

Tests

To run tests, just do :

  grunt test

License

Gizu is licensed under the MIT Licence, courtesy of marmelab.