Skip to content

A visualizer of git repository statistics like the 'github grass'.

License

Notifications You must be signed in to change notification settings

corestate55/gh-file-grass

Repository files navigation

gh-file-grass

A visualizer of git repository statistics like the 'github grass'.

Demo

Reference

Blog

Requirements

This repository includes two tools.

  • Repository data collector
  • Repository data visualizer

The collector is ruby script, and the visualizer is Node.js application. So, a environment which works ruby and Node.js work is required.

Development of these tools are on environments below:

Project setup

Setup collector

Install gems.

bundle install --path=vendor/bundle

Setup visualizer

Install npm packages.

npm install

Generate repository data

Run the collector to generate repository data and save the output as name public/logs.json, because the file name of repository data is hard-corded in visualizer (currently).

bundle exec ruby ./bin/log_collector.rb -r /path/to/repository > ./public/logs.json

Options:

  • -n COUNT: number of logs
  • -p: pretty-print

Run visualizer

Run visualizer with HTTP server. (localhost:8000 in default.)

npm run serve

Notes for visualizer

Compiles and hot-reloads for development

npm run serve

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

About

A visualizer of git repository statistics like the 'github grass'.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published