This module implements a node.js-based service to generate the genome reports used in the comprehensive genome analysis service.
This module is a component of the BV-BRC build system. It is designed to fit into the
dev_container infrastructure which manages development and production deployment of
the components of the BV-BRC. More documentation is available here.
- node (8.9.1+)
- npm (5.6.0+)
cd genome_report
npm install
The following will not install any dev dependencies
npm install --production
Create html report, given GTO (Genome Typed Object) as input
./create-report.js -i sample-data/bin2.1.genome -o reports/test-report.html
Serve repo and listen for changes with
npm start
npm run build
This will generate three different reports with the sample data found in sample-data/.
Handlebars is used for templating (templates/gr-template.html). A full list of helpers is available here: handlebars-helpers