An open API service indexing awesome lists of open source software.

https://github.com/yuvenalmash/dl-scan


https://github.com/yuvenalmash/dl-scan

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

        


DL SCAN


# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [📝 License](#license)

# 📖 DL SCAN

**DL Scan** is a web application that allows users to scan and store their driver's license information. The application will use OCR to extract the information from the driver's license and display it. The application works fully on the client side.

## 🛠 Built With

### Tech Stack

The following technologies were used in the development of this project:

- **React (Next.js)** for the user interface.
- **React-webcam** for capturing images.
- **Python** for the image processing with the modules below:
- **OpenCV** for image processing.
- **Tesseract** for OCR.

### Key Features

- **Capture Image**: Users can capture an image of their driver's license using their device's camera.
- **Extract Information**: The application will use OCR to extract the information from the driver's license.
- **Display Information**: The extracted information will be displayed in tabular form.

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Setup

Clone this repository to your desired folder:

```sh
git clone [email protected]:yuvenalmash/dl-scan.git
cd dl-scan
```

### Install

Install node modules with:

```sh
npm install
```
Install python modules with:

```sh
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

### Usage

To run the project, execute the following command:

```sh
npm run dev
```

(back to top)

## 👥 Authors

👤 **Yuvenal Njoroge**
- GitHub: [@yuvenalmash](https://github.com/yuvenalmash)

(back to top)

## 🔭 Future Features

The extract part of the application is incomplete. The following features are planned for the future:

- [ ] **Add an adaptable image processing to prepare for OCR**.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)