Skip to content
Piers Sinclair [SSW] edited this page Sep 16, 2024 · 13 revisions

Welcome to the SSW.CodeAuditor Wiki!

1. Code Auditor Vision

CodeAuditor's main docker script to be easily added and ran on any DevOps project's production pipeline to perform scanning on the go To scan for broken links and bad HTML code on deployed projects so developers can easily find and fix errors on their websites To perform Load Testing and Lighthouse audit so developers can see how well their websites are performing To be featured on CTF to encourage more developers to use

2. Technologies

  • Front end - Svelete UI
  • Back end - Firebase API (+ some Golang and some Node.js)
  • Hosting - Firebase Service
  • Database - Azure Table (classic) and Blob Storage

2.1 Why we are using Golang?

2.2 Is this the correct way to implement rules checking?

  • In accordance with the guidelines set forth by HTMLHint, this represents the precise manner in which regulations for HTML standards are to be implemented.

2.3 Are there any other libraries which Microsoft have developed which could replace the current HTMLHint

  • To date, we have yet to identify any Microsoft-provided alternatives for conducting static code analysis of HTML.

2.4 Why we are Firebase?

  • The Firebase interface streamlines server operations and internal functions, resulting in a user-friendly experience that is both efficient and time-saving.
  • With Firebase handling the bulk of operational tasks, developers are afforded the luxury of dedicating additional time towards app development.
  • Firebase offers a rapid means of validating app concepts, allowing for effortless migration to a more robust "enterprise" configuration.

3. CodeAuditor's Architecture Diagram

Untitled Diagram

Figure: CodeAuditor's Architecture Diagram

4. Currently Supported Features

  • Scanning for broken 404 links
  • Scanning for HTML code warning/error
    • Adding custom HTML rules
    • Selecting custom HTML rules per scan
  • Perform Load Testing using Artillery
    • Setting threshold for load testing result
  • Perform Google Lighthouse Audit
    • Setting threshold for audit result
  • Comparing previous to current scan
  • Sending automated alert emails

5. Some examples of Products using CodeAuditor

  • SSW Rules
  • SSW Website
  • SSW People