NOTE: This app has been merged and retired - see guidance-guarantee-programme/output instead

Summary Generator

Generate Pension Wise summary documents in PDF format only.

Prerequisites

• Bundler
• Git
• Node.js
• PrinceXML
• NPM
• PostgreSQL
• Ruby 2.3.0
• Signon

Installation

Clone the repository:

$ git clone https://github.com/guidance-guarantee-programme/summary_generator.git

Setup the application:

$ ./bin/setup

Download and install PrinceXML, and make sure it is available on the path. Generated PDFs will have a PrinceXML watermark unless you install a valid PrinceXML licence.

Details on the PrinceXML website.

Usage

To start the application:

$ ./bin/foreman s -p <port>

where is the port you'd like the application to listen on.

Production-mode

To run the application in "production" mode, the following environment variables need to be set:

• RAILS_ENV=production
• SECRET_KEY_BASE=<some secret token>

Heroku

Contributing

Please see the contributing guidelines.