docflow-windows

document processing system

This repository contains the Windows application for a document processing system. It allows users to upload and process documents via OCR, review and correct extracted data, and submit the final version. The app automatically monitors a folder for new documents, sends them to a processing server, and handles user verification and corrections. This repo focuses on the desktop application, which interacts with separate repositories for the processing server and admin dashboard.

Architecture 🗂️

The component diagram of the system is provided below.

How to Use ⚙️

Prerequisites

• Git
• Visual Studio 2022 with the following workloads installed:
  • .NET desktop development (available through the Visual Studio Installer)
  • WinUI application development (available through the Visual Studio Installer)

Steps

Environment Setup

1. Run Visual Studio 2022 as administrator.

Running as administrator is required for the HTTP listener to function when the application is in headless operational mode. The application can still run without administrator privileges, but it will not be able to listen for document processing requests.

2. In the Get started section, select Clone a repository.
3. In the Repository location field, paste the following URL:

https://github.com/kanitakadusic/si-docflow-windows.git

4. Click the three dots next to the Path field, choose an empty folder as the solution location, then click Select Folder.
5. Click Clone.

Configuration File Setup

In Solution Explorer, navigate to Solution 'docflow' > docflow > appsettings.json.
Update appsettings.json with your configuration. See appsettings-setup.md for details.

Application Debug

1. Set the startup project to docflow (Unpackaged).
2. Set the build configuration to Debug.
3. Run the application.

Application Publish (with required DLLs)

1. In Solution Explorer, right-click the docflow project and select Publish.
2. Under Target, select Folder, then click Next.
3. Under Specific target, select Folder, then click Next.
4. Click Browse next to the Folder location field, choose an empty folder as the publish output location, then click OK.
5. Click Finish, then Close.
6. On the docflow: Publish screen, click Show all settings.
7. In the Configuration field, select Release | <platform>.
8. Set Deployment mode to Framework-dependent.
9. Set Target runtime to win-<platform>.
10. Click Save, then Publish.

Documentation 📚

• Application Settings Setup
• API documentation
• Questions and Answers

Instructional Videos 🎥

👉 Click here to watch the local setup video (4 minutes 37 seconds)