Getting Started with Qualityfolio
Qualityfolio is a code-first Test Management system built on the Test Management as Code (TMaC) approach. It enables teams to author, version, ingest, and visualize test artifacts using structured Markdown files and automated pipelines.
This guide walks you through installing the required tools, generating a queryable SQLite database from Qualityfolio artifacts, and launching the HTML Test Management Dashboard.
Watch the quick start video to understand the overall workflow.
Qualityfolio Requirements
Before installing Qualityfolio, ensure the following tools and files are available in your environment. These components work together to ingest test artifacts, transform them into structured data, and render the test management dashboard.
- Homebrew (required to install Spry)
- Spry (runbook and SQLPage orchestration)
- Surveilr (ingestion and data processing engine)
- SQLPage (HTML dashboard renderer)
qualityfolio.md– Qualityfolio runbookqualityfolio-json-etl.sql– ETL scriptsqlpage/sqlpage.json– SQLPage configuration
Installing Qualityfolio
Follow the steps below to install all required dependencies. Run the commands from your workspace directory.
Switch to your workspace directory:
Install Homebrew
Homebrew is required to install Spry and manage dependencies.
Install Spry
Spry is used to run Qualityfolio runbooks and generate SQLPage assets.
Install Surveilr
Surveilr ingests Qualityfolio artifacts and produces the SQLite database. Version 3.10.0 or above is required.
Generate SQLite Database
Open a terminal, navigate to the qualityfolio folder, and execute the following command to ingest test artifacts and generate the SQLite database.
Generate Test Management Dashboard
Launch the Test Management Dashboard using two terminals, both opened from the qualityfolio folder.
Terminal 1: Generate SQLPage assets and watch for changes.
Terminal 2: Start the SQLPage server.
Open http://localhost:9227 in your browser to view the Qualityfolio Test Management Dashboard.