diff --git a/README.md b/README.md index 9c3ee1c9..fbc52b35 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# DocuNova +
+ DocuNova Logo +

DocuNova

+

Intelligent Document Processing & Management

+
## Overview @@ -15,6 +19,48 @@ It is designed for flexibility and configurability through environment variables The project includes a **UI** for uploading and managing files, and an API documentation page is available at `/docs` (powered by **FastAPI**). +## Screenshots + +
+ DocuNova Upload Interface +

Upload interface for adding new documents

+ + DocuNova Files View +

Files view with processed documents and metadata

+
+ +## Workflow Process + +DocuNova follows a streamlined document processing workflow: + +
+ DocuNova Workflow +
+ +### Document Ingestion +Documents enter DocuNova through three possible channels: +1. **Web Upload**: Users manually upload files via the web interface +2. **Email Attachments**: Automatic polling of configured IMAP mailboxes (supports multiple accounts) +3. **API**: Direct programmatic uploads via the REST API + +### Processing Pipeline +Every document goes through the following steps: +1. **PDF Conversion**: Non-PDF files are converted to PDF format using Gotenberg +2. **OCR Processing**: Azure Document Intelligence extracts text from images/scans +3. **Metadata Extraction**: OpenAI analyzes document content to identify: + - Document type (invoice, receipt, contract, etc.) + - Key entities (dates, names, amounts, account numbers) + - Important data points specific to the document type +4. **Enrichment**: Metadata is attached to the document in a structured format + +### Distribution +Processed documents with their metadata can be automatically sent to: +- **Dropbox**: For cloud storage and sharing +- **Nextcloud**: For self-hosted file storage +- **Paperless-NGX**: For advanced document management with search capabilities + +Users can choose to send documents to any combination of these destinations through configuration settings or manual selection. + ## Features - **Document Upload & Storage**: diff --git a/docs/files-view.png b/docs/files-view.png new file mode 100644 index 00000000..8762a37a Binary files /dev/null and b/docs/files-view.png differ diff --git a/docs/upload-view.png b/docs/upload-view.png new file mode 100644 index 00000000..34242964 Binary files /dev/null and b/docs/upload-view.png differ diff --git a/docs/workflow-diagram.png b/docs/workflow-diagram.png new file mode 100644 index 00000000..7b21e84d Binary files /dev/null and b/docs/workflow-diagram.png differ