tracking_kits/docs/index.md

tracking_kits Documentation Index

Type: monolith Primary Language: Classic ASP / VBScript Architecture: MVC-style server-rendered web application with repository-backed data access Last Updated: 2026-03-13

Project Overview

tracking_kits is a Windows-hosted Classic ASP application for election mail operations. It helps staff create mail tracking kits, generate proofs, prepare inkjet output files for printers, and export tracking data for downstream mail-tracking systems such as SnailWorks.

The application is not a modern REST service. It is a server-rendered IIS site that routes requests into controller .asp files, renders views from App/Views, and accesses an Access/Jet database through repository classes under App/DomainModels.

Quick Reference

• Entry Point: ../index.asp
• Primary Bootstrap: ../App/include_all.asp
• Route Initialization: ../App/app.config.asp
• MVC Framework: ../MVC
• Application Code: ../App
• Database Migrations: ../Data/Migrations
• Import/Automation: ../ImportService
• Tests: ../Tests

Generated Documentation

• Project Overview - Purpose, classification, stack, and major capabilities.
• Source Tree Analysis - Annotated repo layout and critical folders.
• Architecture - Runtime architecture, request flow, dependencies, and constraints.
• Development Guide - Local setup, IIS assumptions, test execution, and change workflow.
• Component Inventory - Controllers, repositories, UI surfaces, shared libraries, and automation components.
• Data Models - Core tables, relationships, and migration history.
• API Contracts - Route/action surface and non-HTTP export interfaces.
• Module Map - Feature-by-feature guide to the files you should open first when making changes.

Existing Documentation

• README.md - Short project summary and current running notes.
• AGENTS.md - Repository conventions and BMAD skill instructions used in this workspace.

Getting Started

Runtime Prerequisites

• Windows with IIS and Classic ASP enabled
• Access/Jet or ACE database provider
• COM components used by the app registered on the host if you need printing/export features
• Access to the configured export/import network shares in non-dev environments

Local Development

1. Point an IIS site at the repository root.
2. Ensure index.asp is a default document and Classic ASP is enabled.
3. Review ../App/app.config.asp for the active dev mode and export directory mapping.
4. If you need printer/proof/export behavior, verify the COM dependencies under ../Dependancies are installed and licensed.

Tests

• Open ../Tests/Test_All.asp through IIS to run the ASPUnit suite.
• The automated tests primarily cover helper libraries, not the full application workflow.

For Brownfield Changes

• Read architecture.md first for the request/data flow.
• Read module-map.md next if you already know which feature area you need to change.
• Read data-models.md before touching repositories or migrations.
• Read development-guide.md before changing environment-sensitive code.
• Read _bmad-output/project-context.md before asking an AI agent to implement changes.

---

Documentation generated for brownfield analysis.