README.md

Tracker

This project tracks the Government of Canada domains for adherence to digital security best practices and federal requirements.

Repo Structure

This project is organized in the monorepo style with the various components separated into their own folders.

.
├── api
├── ci
├── frontend
├── platform
├── README.md
├── scripts
└── services

The ci folder contains an image used in the CI process, but the main event is the next three folders: The frontend, and api folders containing the two main parts parts of the applicationand the platform folder which contains the Kubernetes configuration needed to deploy the tracker on the cloud provider of your choice. The scripts folder is a dumping ground for various utility scripts and services contains the code for our scanning services.

Application structure

In accordance with TBS policy stating developers should "Validate your API design by consuming it", and "Use microservices built around business capabilities." the application is architected as an API/consumer pair giving a minimalist microservices architecture.

Further details can be found in the README files contained in their respective folders.