{"id":26593705,"url":"https://github.com/terryminn/ocr-service","last_synced_at":"2025-08-02T09:11:35.794Z","repository":{"id":283037489,"uuid":"950471847","full_name":"TerryMinn/OCR-Service","owner":"TerryMinn","description":"A microservice-based OCR tool that extracts text from images using AWS Textract. Built with NestJS, this service provides a secure REST API with API key authentication.","archived":false,"fork":false,"pushed_at":"2025-03-18T08:15:09.000Z","size":117,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T09:27:27.249Z","etag":null,"topics":["aws-textract","microservice","nestjs","ocr"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TerryMinn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-18T08:05:56.000Z","updated_at":"2025-03-18T08:15:13.000Z","dependencies_parsed_at":"2025-03-19T00:30:27.264Z","dependency_job_id":null,"html_url":"https://github.com/TerryMinn/OCR-Service","commit_stats":null,"previous_names":["terryminn/ocr-service"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TerryMinn%2FOCR-Service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TerryMinn%2FOCR-Service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TerryMinn%2FOCR-Service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TerryMinn%2FOCR-Service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TerryMinn","download_url":"https://codeload.github.com/TerryMinn/OCR-Service/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245120105,"owners_count":20563862,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-textract","microservice","nestjs","ocr"],"created_at":"2025-03-23T15:20:03.101Z","updated_at":"2025-03-23T15:20:03.846Z","avatar_url":"https://github.com/TerryMinn.png","language":"TypeScript","readme":"# 📝 OCR Service (Image to Text Extractor)\n\n[![GitHub](https://img.shields.io/badge/GitHub-Repo-blue?logo=github)](https://github.com/your-repo/ocr-service)\n\nA **microservice-based OCR** tool that extracts **text from images** using **AWS Textract**. Built with **NestJS**, this service provides a secure **REST API** with **API key authentication**.\n\n## 🚀 Features\n\n✅ Extract text from images using **AWS Textract**  \n✅ Secure **REST API** with **API Key authentication**  \n✅ **Scalable microservice** architecture  \n✅ Easy deployment with **Docker** or **Cloud services**\n\n## ⚙️ Tech Stack\n\n- **NestJS** - Backend framework 🏗️\n- **AWS Textract** - OCR processing ☁️\n- **REST API** - API architecture 🌍\n- **API Key Authentication** - Secure access 🔑\n\n## 🛠 Installation \u0026 Setup\n\n### 📌 Prerequisites\n\n- **Node.js** installed\n- **AWS account** with Textract access\n\n### 🔧 Steps to Run\n\n1. Clone the repository:\n\n   ```sh\n   git clone https://github.com/TerryMinn/OCR-Service\n   cd ocr-service\n   ```\n\n2. Install dependencies:\n\n   ```sh\n   npm install\n   ```\n\n3. Set up environment variables:\n   Create a `.env` file and configure the following:\n\n   ```env\n   RESPONSE_URL=\n   SECRET_KEY=\n   EXPIRES_IN=\n   AWS_REGION=\n   AWS_ACCESS_KEY_ID=\n   AWS_SECRET_ACCESS_KEY=\n   OCR_API_KEY=\n   ```\n\n4. Start the service:\n   ```sh\n   npm run start\n   ```\n\n## 🔥 API Docs\n\n### local doc\n\n```\nhttp://localhost:8000/\n```\n\n### 1️⃣ Extract Text from Image\n\n📌 **Endpoint:** `POST api/v1/ocr/scan`\n\n📌 **Headers:**\n\n```json\n{\n  \"x-api-key\": \"your_api_key\"\n}\n```\n\n📌 **Body (multipart/form-data):**\n\n```json\n{\n  \"passport\": \"(Upload image file)\"\n}\n```\n\n📌 **Response:**\n\n```json\n{\n  \"text\": \"Extracted text from image\"\n}\n```\n\n## 🔐 Security\n\n🔹 Uses **API key authentication** for secure access.  \n🔹 Store API keys **securely** and never expose them in public repositories.\n\n## 🚀 Deployment\n\nThis service can be deployed using **Docker**, **AWS Lambda**, or any **cloud platform** supporting **NestJS**.\n\n## 👨‍💻 Author\n\nDeveloped by **Terry Minn**  \n📩 Contact: [shinnthantmindev.mm@gmail.com]\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterryminn%2Focr-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterryminn%2Focr-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterryminn%2Focr-service/lists"}