Skip to content

SSWConsulting/SSW.CodeAuditor

Repository files navigation

SSW Code Auditor

Build Status Docker Pull Docker Size

SSW CodeAuditor is a code and link analysis tool that allows users to identify broken links or code, view the overall performance of your website, ensuring large, complex source code can be simplified, cleaned and maintained. With CodeAuditor, you can:

  • View prior scan history - View previous scan results
  • Export to CSV - Export scan result to CSV to perform further analysis (PowerBI)
  • View Lighthouse report - See Lighthouse numbers within CodeAuditor
  • Set Lighthouse threshold - E.g. If performance is less than 80 and SEO score is less than 100, fail the build
  • Ignore broken links - Ignored URLs will not cause build to fail
  • View code errors - View HTML code errors and code errors within CodeAuditor

Architecture Diagram

image

Figure: CodeAuditor Architecture Diagram

Usage

  1. Sign up for free at https://codeauditor.com and get your token
  2. Make sure Docker is installed and running on your local machine
  3. Use the token from step 1 and run a command from the Homepage

npm start

To start developing CodeAuditor:

We always welcome contributions. If you are interested in contributing, please take a look at our CONTRIBUTING guide

Technologies used in CodeAuditor

Front End:

SvelteJs - Free and open-source JavaScript framework

Back End:

Firebase - CodeAuditor uses Firebase API, allowing developers to avoid managing servers or writing server-side code

Why Firebase?

  • Easy to use and save a lot time because all the server operations and internal functions are taken care of by the Firebase interface
  • Developers can spend more time developing the app
  • The idea of firebase is to quickly validate your idea then you can simply migrate that to a proper "enterprise" set up

Tool:

Docker - Platform as a service (PaaS) product that uses OS-level virtualization to deliver software in packages

Getting help

  • Leave comments on your PR and @ people for attention
  • Bring it up with the team
  • Edit the Wiki
  • For help: email the Product Champion or ask on Teams