Home

TFRS Project Documentation

Description

TFRS is a web application being built to support the Low Carbon Fuels Program.

What is the TFRS Project producing?

• A Credit Transfer App - Dev is being built (https://dev.lowcarbonfuels.gov.bc.ca/) to host the products of this Low Carbon Fuels program.
  • Business Scenarios
  • Enabling Functionality (Business)
    • Planned: Please see the product features page for the product roadmap
    • Released: All releases are described in the Github Releases
  • Enabling Solutions (Technology)
    • Application-Deployment-Strategy-and-Roll-Back-Method
    • Authentication-and-Authorization
    • Self-Signed-Certificate
    • Create-staging-database
    • DevOps-Pipeline
    • Load-Fixtures
    • OpenShift-projects-backup-and-restore
    • Overview-of-Testing
    • Postgresql-Database-Backup-and-Restore
    • TFRS-Git-Branching-Model
    • TFRS-Public-URLs-Routes-and-Services
  • Consumers (Users)
• The TFRS product is tracking its tasks and issues using the tool Trello: This contains the backlog of User Stories for the Product and the activity associated with their completion
• As part of this project the team is contributing to the development of a DevOps deployment pipeline as well as an Agile Software Development Life-Cycle approach that works for BC Government scrum teams.

How can I collaborate with the TFRS Team?

• TFRS Slack Channel
• Team Members

Information for the Development Team:

• GitHub Readme: (README.md)
• Import the YAML API Specification Using the Online Swagger Editor to View and Test the API
• OpenShift Console (Permission Required, need to be in the BCGOV and BCDevOps github organizations. You can request access through slack)
• Wireframes:
  • HTML Mockups directory on Git
  • Mockups - Balsamiq Wireframes on Cloudcompass
  • Balsamiq Source versions on Sharepoint. Go to: wireframe archive - Balsamiq source.
  • V1 PDFs
  • V2 PDFs
• Style Guide
• Specifications for Testing: Behaviour Driven Design
• TFRS-Dev Browsable API allows for users to manual interact with the system through this human friendly html output.
• Application Health Check
• Sharepoint site: https://spc-mem.gov.bc.ca/tfrs/SitePages/Home.aspx
• Code Quality Scan Dashboard
• Testing Coverage Report - This will give a report on the degree to which our application code has been tested and allow us to drill down to the lines of code that are not tested, so we can write tests for them and continually improve the code quality
• Application Vulnerabilities Report
• automated redeployment of the schema spy (in progress)