RETIRED, Tech community metrics dash of the OpenStack community based on the Metrics Grimoire toolset

Go to file

Luis Cañas Díaz 31cc080157 Top 10 companies links list supports now newest format of scm-companies.json Change-Id: I40fa2b4ea3ea1681b5e71963afe33f50fa1a0167		2014-10-11 13:02:13 +02:00
browser	Top 10 companies links list supports now newest format of scm-companies.json	2014-10-11 13:02:13 +02:00
doc	Upgrade dash to latest version with release support	2014-08-29 13:36:08 +02:00
templates	Enable OverallSummaryBlock section for release.html	2014-10-07 18:31:34 +02:00
test/jasmine	Upgrade dash to latest version with release support	2014-08-29 13:36:08 +02:00
.gitreview	Add .gitreview	2013-10-15 21:55:27 +00:00
LICENSE	wrong dir	2013-07-03 19:45:24 +02:00
Makefile	Upgrade dash to latest version with release support	2014-08-29 13:36:08 +02:00
README.md	Upgrade dash to latest version with release support	2014-08-29 13:36:08 +02:00
index.html	Upgrade dash to latest version with release support	2014-08-29 13:36:08 +02:00

README.md

Intro

VizGrimoireJS aims at providing a framework for software metrics visualization using HTML, CSS and JavaScript as main technologies.

It was born as a complement to the outcomes of VizGrimoireR project (now GrimoireLib), whose main focus is to parse information from any of the tools found in Metrics Grimoire project.

Q. What libraries are used by this front-end?

Bootstrap 3.1.1
Jasny Boostrap 3.1.3
JQuery 1.11.1
VizGrimoireJS-lib

Q. How do I generate the HTML?

make

Q. How do I clean the generated HTML?

make clean

Q. Where do I include the JSON files?

Copy them to the directory browser/data/json

Q. Where is the famous metrics.json file located?

It is located at browser/data/metrics.json

Q. What if I don't want project support?

The project hierarchy is provided by the file browser/data/json/projects_hierarchy.json, if the file is not present the dash works with no subprojects support.

Q. What if I don't want to generate all the HTML files?

Easy, comment the proper lines in the shell script at templates/gen.sh