https://github.com/neozhu/mailscan
designed for scanning and sorting mail based on recipient information.
https://github.com/neozhu/mailscan
mail-ocr mail-recognition mailscanner
Last synced: 26 days ago
JSON representation
designed for scanning and sorting mail based on recipient information.
- Host: GitHub
- URL: https://github.com/neozhu/mailscan
- Owner: neozhu
- License: mit
- Created: 2023-12-20T10:46:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-03T11:10:53.000Z (over 1 year ago)
- Last Synced: 2025-06-20T17:06:37.602Z (4 months ago)
- Topics: mail-ocr, mail-recognition, mailscanner
- Language: TypeScript
- Homepage: https://mailscan.blazorserver.com/
- Size: 11.1 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MailScan - SvelteKit App for Efficient Mail Sorting
[](https://github.com/neozhu/mailscan/actions/workflows/node.js.yml)
[](https://github.com/neozhu/mailscan/actions/workflows/docker-publish.yml)
## Overview
MailScan is an advanced application, spearheading innovations in mail sorting processes. It leverages state-of-the-art camera scanning and text recognition technologies to significantly improve the efficiency of mail delivery systems. The primary function of MailScan is to meticulously scan envelopes and accurately identify recipient details, thereby enabling sorting personnel to effectively categorize mail based on the recipient's department and office location.
Crafted with the cutting-edge Svelte framework, MailScan excels in performance and offers a user-friendly interface. This makes it an invaluable tool for modern mail handling operations, seamlessly integrating the latest in web technology with practical mail management solutions.
## Features
- **Envelope Scanning**: Utilizes device cameras to capture images of mail envelopes.
- **Text Recognition**: Employs Optical Character Recognition (OCR) to extract recipient information from envelopes.
- **Departmental Sorting**: Determines the corresponding department and office location for each recipient.
- **Efficiency Reports**: Generates reports to track sorting efficiency and identify areas for improvement.
## Getting Started
### Prerequisites
- SvelteKit
- PocketBase
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
# set PocketBase URL in .env
PUBLIC_POCKETBASE_URL=http://10.33.1.166:3010/
BODY_SIZE_LIMIT=5291456 # 5mb
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Building
To create a production version of your app:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
## Building Image
```bash
docker build -t mailscankit:latest .
docker run -d -p 3000:3000 mailscankit:latest
```
## Docker Run
```bash
# Docker Pull Command
docker pull blazordevlab/mailscankit:latest
docker run -d -p 3000:3000 \
-e BODY_SIZE_LIMIT=5291456 \
-e PUBLIC_POCKETBASE_URL=http://127.0.0.1:3010 \
blazordevlab/mailscankit:latest
```
### Usage
1. Open the app in a web browser.
2. Grant the necessary permissions for the app to access the device camera.
3. Place the envelope under the camera and click the 'Scan' button.
4. View the extracted recipient details and the assigned sorting category.
## How It Works:
1. Scan: The assistant uses their smartphone to scan the letters through the application.
2. OCR Processing: Once the image of the letter is sent to the backend (powered by Python FastAPI service), OCR technology extracts the text.
3. NLP Analysis: The application then performs natural language processing to identify names within the letter.
4. Database Lookup: It uses these names to search a database for the employee's details, including their department and office address.
## Technologies Used
- TypeScript
- Docker
## Contributing
Contributions to MailScan are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) for more information on how you can contribute to this project.
## License
This project is licensed under the [MIT License](LICENSE).
## Support and Contact
For support, feature requests, or any queries, please [open an issue](https://github.com/neozhu/mailscan/issues) in this repository.