Tech Audit Tool API

Overview

This API links with the KEH Tech Audit Tool frontend.

This repository contains the infrastructure and code for deploying an API using Terraform on AWS. The project is structured to support multiple environments.

TechStack Overview

This project is built using Poetry for dependency management and MkDocs for generating the documentation site.

The API Python code is built using Flask Restx.

Infrastructure Overview

The API infrastructure is built using Terraform. The API Gateway available on AWS is used to handle the authentication and routing of requests to the Lambda function.

To deploy the API, the Terraform code is run to create the necessary resources on AWS. The Terraform code is located in the terraform directory. A certain pattern is to be followed when deploying a brand new API.

Getting Started

Check out the README.md file in the root of the repository for more information.