You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -37,20 +37,14 @@ MatchFlow delivers real, measurable value by automating repetitive finance tasks
37
37
2.[ Key Features](#key-features)
38
38
3.[ Tech Stack](#tech-stack)
39
39
4.[ Architecture](#architecture)
40
-
5.[ Screenshots / Demo](#screenshots--demo)
40
+
5.[ Screenshots](#screenshots)
41
41
6.[ Getting Started](#getting-started)
42
42
-[ Prerequisites](#prerequisites)
43
43
-[ Installation](#installation)
44
44
-[ Configuration](#configuration)
45
45
-[ Running the App](#running-the-app)
46
-
7.[ API Reference](#api-reference)
47
-
8.[ Usage Examples](#usage-examples)
48
-
9.[ Testing](#testing)
49
-
10.[ Deployment](#deployment)
50
-
11.[ Roadmap](#roadmap)
51
-
12.[ Contributing](#contributing)
52
-
13.[ License](#license)
53
-
14.[ Contact / Support](#contact--support)
46
+
7.[ License](#license)
47
+
8.[ Contact / Support](#contact--support)
54
48
55
49
56
50
<aid="key-features"></a>
@@ -332,7 +326,7 @@ _All inside the .NET API Gateway container_
332
326
- Plain C# business entities: Invoice, PurchaseOrder, InvoiceLineItem, PurchaseOrderLineItem, ExceptionRecord, User
333
327
334
328
335
-
329
+
<aid="screenshots"></a>
336
330
## Screenshots
337
331
### Authentication
338
332
@@ -378,3 +372,122 @@ Now you’re all set to run the auto-match and reconcile against your purchase o
378
372
*Figure 6: The Auto-Match engine processes your invoice and then confirms a 100% match—every line item and the total perfectly aligned with your Purchase Order.*
379
373
380
374
Instant peace of mind knowing your invoice is exactly what you ordered.
375
+
376
+
377
+
<aid="getting-started"></a>
378
+
## Getting Started
379
+
380
+
Follow these steps to get MatchFlow up and running locally via Docker Compose.
381
+
382
+
---
383
+
384
+
### Prerequisites
385
+
386
+
#### Local Development Tools
387
+
-**Docker Engine** ≥ 20.10
388
+
-**Docker Compose** ≥ 1.29
389
+
- A modern web browser (Chrome, Firefox, Safari, Edge)
390
+
391
+
#### Azure Resources
392
+
Before running MatchFlow, you need to set up these Azure services:
393
+
394
+
-**Azure Blob Storage**
395
+
- Create a storage account
396
+
- Create a container for PDF storage
397
+
- Get the connection string and container name
398
+
399
+
-**Azure Form Recognizer**
400
+
- Create a Form Recognizer resource
401
+
- Get the endpoint URL and API key
402
+
403
+
> **Note:** These Azure resources are required for PDF storage and OCR processing. You'll configure them in the `.env` file during installation.
> **Note:** Populate the `AZUREBLOB__*` and `FORMRECOGNIZER__*` keys in your `.env` file with the Azure resource details you set up in the Prerequisites section.
0 commit comments