ngx-image-id-detector/README.md

A package that detects if an image is a Vietnamese citizen ID using Tesseract.js

# 📷 ngx-image-id-detector

**ngx-image-id-detector** is an Angular library for detecting whether an image is a Vietnamese Citizen ID card (CCCD) using OCR (`Tesseract.js`). It can distinguish between the front side, back side, or unrecognized images.

## ✨ Features

* ✅ Detects the **front** side of CCCD
* ✅ Detects the **back** side of CCCD
* ❌ Distinguishes invalid images (blurred, glare, cropped, not CCCD)
* 🔠 Supports Vietnamese language with Tesseract.js (`lang: vie`)
* 🔁 Returns results as Observable, suitable for Angular

---

## 📦 Installation

```bash
npm install ngx-image-id-detector tesseract.js
```

---

## 📋 Version Compatibility

| ngx-image-id-detector | Angular version | Tesseract.js version |
| --------------------- | --------------- | -------------------- |
| 1.x                   | 16+             | 4.x                  |
| 0.x                   | 13–15           | 2.x                  |

---

## 🧪 Example

Demo source is available in the `example/` folder:

```ts
import { DetectIdService } from 'ngx-image-id-detector';

constructor(private detectIdService: DetectIdService) {}

onImageSelected(file: File) {
  this.detectIdService.detect(file).subscribe(result => {
    console.log(result);
  });
}
```

## ✅ Result Structure

```ts
interface DetectIdResult {
  side: 'front' | 'back' | 'unknown';
  text: string;
}
```

---

## 🌐 GitHub Repository

👉 [https://github.com/nguyentrunghieutcu/ngx-image-id-detector](https://github.com/nguyentrunghieutcu/ngx-image-id-detector)

---

## 📄 License

[MIT](LICENSE)