Skip to content

PixText is a backend service built with NestJS that extracts text from uploaded images using an efficient, event-driven pipeline. It integrates AWS S3, BullMQ, MongoDB, and WebSockets to provide asynchronous, scalable text extraction with real-time updates to the client.

Notifications You must be signed in to change notification settings

Julz-bit/pixtext-api

Repository files navigation

Description

PixText is a backend service built with NestJS that extracts text from uploaded images using an efficient, event-driven pipeline. It integrates AWS S3, BullMQ, MongoDB, and WebSockets to provide asynchronous, scalable text extraction with real-time updates to the client.

📸 Client Uploads Image -> 🌐 NestJS Uploads to S3 -> 🐂 BullMQ Queue Adds OCR Job -> ⚙️ Worker Extracts Text -> 🗄️ MongoDB Saves Result -> 📢 EventEmitter → WebSocket Gateway -> 💬 Client Receives OCR Result (live update)

Installation

$ pnpm install

Running the app

# development
$ pnpm dev

Swagger

$ {APPURL}/api

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

About

PixText is a backend service built with NestJS that extracts text from uploaded images using an efficient, event-driven pipeline. It integrates AWS S3, BullMQ, MongoDB, and WebSockets to provide asynchronous, scalable text extraction with real-time updates to the client.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published