# 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](../index.asp)
- **Primary Bootstrap:** [../App/include_all.asp](../App/include_all.asp)
- **Route Initialization:** [../App/app.config.asp](../App/app.config.asp)
- **MVC Framework:** [../MVC](../MVC)
- **Application Code:** [../App](../App)
- **Database Migrations:** [../Data/Migrations](../Data/Migrations)
- **Import/Automation:** [../ImportService](../ImportService)
- **Tests:** [../Tests](../Tests)

## Generated Documentation

- [Project Overview](./project-overview.md) - Purpose, classification, stack, and major capabilities.
- [Source Tree Analysis](./source-tree-analysis.md) - Annotated repo layout and critical folders.
- [Architecture](./architecture.md) - Runtime architecture, request flow, dependencies, and constraints.
- [Development Guide](./development-guide.md) - Local setup, IIS assumptions, test execution, and change workflow.
- [Component Inventory](./component-inventory.md) - Controllers, repositories, UI surfaces, shared libraries, and automation components.
- [Data Models](./data-models.md) - Core tables, relationships, and migration history.
- [API Contracts](./api-contracts.md) - Route/action surface and non-HTTP export interfaces.
- [Module Map](./module-map.md) - Feature-by-feature guide to the files you should open first when making changes.

## Existing Documentation

- [README.md](../README.md) - Short project summary and current running notes.
- [AGENTS.md](../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](../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](../Dependancies) are installed and licensed.

### Tests

- Open [../Tests/Test_All.asp](../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](./architecture.md) first for the request/data flow.
- Read [module-map.md](./module-map.md) next if you already know which feature area you need to change.
- Read [data-models.md](./data-models.md) before touching repositories or migrations.
- Read [development-guide.md](./development-guide.md) before changing environment-sensitive code.
- Read [_bmad-output/project-context.md](../_bmad-output/project-context.md) before asking an AI agent to implement changes.

---

_Documentation generated for brownfield analysis._