FOI Report Download

This is an intranet web-app allowing authenticated users to specify filters and download FOI report in PDF or Excel format.

Features

VueJS frontend and NodeJS backend; with Keycloak authentication on backend (using a confidendial client from Common Hosted Single Sign-On (CSS)).
SiteMinder login
A form allowing user to specify filters and reporting file format
Download report in either pdf or Excel format

Usage

Configuration

Environment Variable	Mandatory	Default	Description
PGUSER	Yes
PGHOST	Yes
PGPASSWORD	Yes
PGDATABASE	Yes
PGPORT	No	5439	Use 443 if proxying
SNOWPLOW_TRACKER_URL	Yes		snowplow tracker url
SNOWPLOW_COLLECTOR_HOST	Yes		snowplow collector host
FILE_STORE_PATH	No	./sessions	path to session file store
TRUST_PROXY	No		express.js trust proxy

Development

VS Code is the preferred dev tool.

Requirements

localhost has access to Redshift
localhost has Node.js v14.19.0 installed (other Node.js versions may work but have not been tested)
localhost has applicable env var above defined
access to a Keycloak realm admin console or to the CSS dashboards
setup a Keycloak client with http://localhost:8080/* as a valid URI redirect (the "Development" installation download from the CSS provides this)

Install & Launch

Run

git clone https://github.com/bcgov/foi-report-download.git
cd foi-report-download
npm i -g yarn
yarn install

Download keycloak.json from Keycloak admin console client's Installation tab to ./keycloak.json

Run

yarn run start

If everything works out, the output should be something like

yarn run v1.22.4
$ node .
launch http://localhost:8080 to explore

Open http://localhost:8080 in browser and login to the app.

Project Status

This project is currently under development and actively supported by the GDX Analytics Team.

Related Repositories

GDX-Analytics/

This is the central repository for work by the GDX Analytics Team.

GDX-Analytics-Looker-FOI/

This is the GDX Analytics project for the FOI Project's Lookml.

Getting Help or Reporting an Issue

For any questions regarding this project, or for inquiries about starting a new analytics account, please contact the GDX Analytics Team.

Contributors

The GDX Analytics Team are the main contributors to this project and maintain the code.

How to Contribute

If you would like to contribute, please see our CONTRIBUTING guideleines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Copyright 2015 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.

bcgov / foi-report-download

readme