Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added table of contents to readme #1638

Merged
merged 4 commits into from
Dec 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,59 @@

This document provides instructions for setting up the environment, running the application, and performing various tasks such as compiling, testing, and contributing to the project.

# Table of Contents

- [CDC Trusted Intermediary](#cdc-trusted-intermediary)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Using and Running](#using-and-running)
- [Generating and using a token](#generating-and-using-a-token)
- [Development](#development)
- [Additional Requirements](#additional-requirements)
- [Generating .env File](#generating-env-file)
- [Using a local database](#using-a-local-database)
- [Compiling](#compiling)
- [Testing](#testing)
- [Unit Tests](#unit-tests)
- [End-to-end Tests](#end-to-end-tests)
- [Automated ReportStream Integration/End-to-End Test](#automated-reportstream-integrationend-to-end-test)
- [Load Testing](#load-testing)
- [Debugging](#debugging)
- [Attached JVM Config for IntelliJ](#attached-jvm-config-for-intellij)
- [Docker Container Debugging Using Java Debug Wire Protocol (JDWP)](#docker-container-debugging-using-java-debug-wire-protocol-jdwp)
- [Steps](#steps)
- [Deploying](#deploying)
- [Environments](#environments)
- [Internal](#internal)
- [Dev](#dev)
- [Staging](#staging)
- [Prod](#prod)
- [Initial Azure and GitHub Configuration](#initial-azure-and-github-configuration)
- [Interacting with Deployed Environments](#interacting-with-deployed-environments)
- [Application](#application)
- [Database](#database)
- [Pre-Commit Hooks](#pre-commit-hooks)
- [Contributing](#contributing)
- [Database](#database-1)
- [Setup with ReportStream](#setup-with-reportstream)
- [CDC-TI Setup](#cdc-ti-setup)
- [ReportStream Setup](#reportstream-setup)
- [Submit request to ReportStream](#submit-request-to-reportstream)
- [Locally](#locally)
- [Orders](#orders)
- [Results](#results)
- [Staging](#staging-1)
- [DORA Metrics](#dora-metrics)
- [Related Documents](#related-documents)
- [CDC Notices](#cdc-notices)
- [Public Domain Standard Notice](#public-domain-standard-notice)
- [License Standard Notice](#license-standard-notice)
- [Privacy Standard Notice](#privacy-standard-notice)
- [Records Management Standard Notice](#records-management-standard-notice)
- [Additional Standard Notices](#additional-standard-notices)
- [Troubleshooting](#troubleshooting)


## Requirements

Any distribution of the Java 17 JDK.
Expand Down
Loading