user_guide.md

Overview

ReportVision is a tool that automates the reading and extracting of labs from PDF's

Steps

1. Annotate Template for a Lab Report
2. Extract Data based on selected annotations
3. Conversion of Extracted Data to PDF's

Getting Started

Prerequisites

1. Python 3.8
2. Node 23.1
3. Tesseract 5.5 (brew install tesseract)
4. Java21
5. PostgreSQL
6. Docker (required for DB and middleware set up)

Installation and Development Guides

1. For Frontend
2. For Middleware
3. For OCR OCR README.

High Level Architecture

flowchart TD
    A[ReportVision UI] --> B[ReportVision Backend]
    B --> C[OCR API]
    B --> D[Data Storage - Postgres]
    C --> D

Loading

The ReportVision application is composed of the following core components:

Components

1. React-Based Single Page Application (SPA)

• Purpose: Serves as the user interface for the application.

2. ReportVision Middleware

• Purpose: Acts as middleware to handle communication between the UI, OCR API, and data storage.

3. OCR API

• Purpose: Performs Optical Character Recognition (OCR) on provided input.

4. Data Storage (PostgreSQL)

• Purpose: Stores saved templates and extracted data.

Infrastructure and Cloud Components

Hosting

• The application is hosted in Azure

Infrastructure Guide

• For detailed information on how the application is deployed and managed in Azure, refer to:
  • ReportVision's Terraform Setup
  • Github Action workflows for building and deploying ReportVision in a dev environment