README.md

TagCheck (Beta)

Table of Contents

• Overview
• Features
• Example
• Development
  • Prerequisites
  • Frontend (Angular)
  • Backend (NestJS)
  • Electron
  • Storybook
• Build and Production
  • Build
  • Package
  • Make
• Feedback and Contribution

Overview

This desktop application automates the Google Tag Manager (GTM) container review process and production analytics deployment validation. It streamlines the quality assurance process by providing:

1. GTM Container Review: Load GTM preview mode, run Chrome recorder, and generate dataLayer correctness reports. Users can review tag configurations through GTM preview mode.
2. Production Analytics Validation: Validate analytics on the production website, ensuring dataLayer accuracy.

Designed for QA, development, and analytics teams, this free standalone tool leverages Angular, NestJS, and Electron.

Features

• Unified JSON Format: Generate GTM-compatible JSON files and run different recorded tests using a consistent specification.
• Video Recording: The entire process is recorded as a .webm video.
• GTM Accompanied Mode: Observe unpublished tags within GTM using a shareable link and the website's landing page.
• Request Capture: Efficiently capture and validate tags automatically. Captured requests are recomposed to data layer object for validation.
• XLSX Report: Test results are encapsulated in an XLSX report, including:
  • Data layer
  • Raw captured requests
  • Reconstructed data layer based on raw captured requests
  • Screenshots of event triggers
• Project Transfer: Archive projects as .zip files for import into other users' applications.

Example

The example project is located at the tag_check_projects folder at the root directory. The ng_gtm_integration_sample project is utilized for end-to-end tests for both backend and frontend. Moreover, the project is also used for development purposes.

Development

This project uses NodeJS v22.10.0 npm v10.9.0 for development. If cannot compile, please run nx reset and rm -rf .nx to reset the project.

Prerequisites

Install dependencies:

npm install -g pnpm

pnpm install

Frontend (Angular)

For development:

pnpm run dev-front

Backend (NestJS)

For development:

pnpm run dev-back

Electron

For Electron development with a development server:

pnpm run dev-electron

Storybook

For Storybook development:

pnpm run storybook-front

Docusaurus

For Docusaurus development:

pnpm run docusaurus-front

Build and Production

Build

Compile the application:

pnpm run build-prod

Output folders (in dist/apps):

• ng-frontend
• nest-backend

Package

Build the Electron app:

pnpm run package

Output will be in the out folder.

Make

Generate a OS-based zip file:

pnpm run make

Actual project and end-to-end tests

Please refer tag_check_projects folder where manages projects under the root direcetory. The ng_gtm_integration_sample project within is utilized for end-to-end tests for both backend and frontend. Moreover, the project is also used for development purposes.

Feedback and Contribution

We welcome your feedback and contributions! If you have suggestions or encounter issues, please file them in the issues section. For those interested in contributing, check out our contribution guidelines (coming soon).