luna_ocr / README.md

Update README.md

9f6ce5a verified 6 months ago

10.9 kB

	---
	title: Luna OCR
	emoji: 🌙
	colorFrom: blue
	colorTo: purple
	sdk: static
	pinned: false
	license: mit
	thumbnail: https://b.l3n.co/i/NgyTV5.jpg
	tags:
	- ocr
	- text-extraction
	- ai
	- gemini
	- thai-language
	---

	<hr>

	<h1><b><center>Luna OCR</center></b></h1>


	# <a href="https://huggingface.co/veela4/luna_ocr/blob/main/README.md" style="text-decoration: none; background-color: transparent;"><img src="https://huggingface.co/veela4/luna_ocr/resolve/main/preview.jpg"><h4 style="font-size: 1em; text-align: center;">"Extract text from any image with AI precision... Don't let language barriers limit your potential, The world is full of text to discover."</h1></a></h1>


	---

	### <h1 style="font-size: 1.75em; font-family: Segoe UI"><center>[FULLSCREEN](https://huggingface.co/veela4/luna_ocr/blob/main/README.md)</center></h1>
	<hr>

	### <center><h1 style="font-size: 1.75em; font-family: Segoe UI">[🚀 Live Demo](https://huggingface.co/veela4/luna_ocr) \| [📥 Download](https://huggingface.co/veela4/luna_ocr/tree/main) \| [📋 Documentation](https://huggingface.co/veela4/luna_ocr/blob/main/README.md)</h1></center>
	<hr>
	<style>▼-preamble {
	font-size: 2em;
	}</style>
	<details id="#contents">

	<summary style="font-size: 2.25em; font-family: Segoe UI"><strong>📋 Contents</strong></summary>
	<hr>

	# <h1 style="font-size: 1.5em;"><strong>
	- [🌙 What is Luna OCR?](#▼-preamble)<p>
	- [⚙️ Usage](#▼-usage)<p>
	- [🚀 Features](#▼-features)<p>
	- [🎨 Capabilities](#▼-capabilities)<p>
	- [📄 Document Processing 📋](#▼-documents)
	- [🇹🇭 Thai Language Support 🌏](#▼-thai)
	- [🖼️ Image Analysis 📸](#▼-images)<p>
	- [🏔️ Example Images ](#▼-examples)
	- [📄 Processing Demo 📋](#▼-processing)
	- [📄 Output Formats �](#▼-outputs)<p>
	- [📄 Instalelation](#▼-installation)<p>
	- [📝 Credits](#▼-credits)<p>
	- [License](#license)<p>
	- [Disclaimer](#disclaimer)

	</strong>
	</h1>
	</details>




	<hr>


	<details id="▼-preamble">

	<summary style="font-size: 2.25em; font-family: Segoe UI"><strong>🌙 What is Luna OCR?</strong></summary>
	<hr>
	<h1>

	Luna OCR is an AI-powered text extraction application that transforms images into editable text with unprecedented accuracy. Built with Google's Gemini 2.5 Flash model, Luna specializes in multilingual text recognition with particular excellence in Thai language processing.

	The name Luna, meaning 'moon' in Latin, represents illumination in darkness - bringing clarity to text hidden within images.

	</h1>
	</details>

	<hr>

	<details id="▼-usage">

	<summary style="font-size: 2.25em; font-family: font-family: Segoe UI"><strong>⚙️ Usage</strong></summary>

	<hr>
	<h1>

	## <h1 style="font-size: 1.5em; text-align: center; font-family: Segoe UI"> Simple steps to extract text from any image:

	\| Step \| Action \|
	\| ----------------- \| ------------------------------------------------------------------ \|
	\| 1 \| Upload your image (PNG, JPG, PDF supported) \|
	\| 2 \| Enter your Gemini API key (stored securely locally) \|
	\| 3 \| Click "Process Image" \|
	\| 4 \| Get extracted text with formatting preserved \|
	\| 5 \| Copy, edit, or download results \|
	\| Optional \| Enable Thai language optimization \|

	🔑 API Key Setup: Get your free Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey)
	</h1>
	</h1>
	<center><a href="https://huggingface.co/veela4/luna_ocr/resolve/main/LunaProcessing.png"><img src="https://huggingface.co/veela4/luna_ocr/resolve/main/LunaProcessing.png" alt="Luna Processing Interface" onclick="window.open('https://huggingface.co/veela4/luna_ocr/resolve/main/LunaProcessing.png', '_blank')"></a></center>
	</details>
	<hr>

	<details id="▼-features">
	<summary style="font-size: 2.25em; font-family: font-family: Segoe UI"><strong>🚀 Features</strong></summary>

	<hr>
	<h1>

	## <h1 style="font-size: 1.5em; text-align: center; color:white; font-family: Segoe UI"> Core capabilities that make Luna OCR special:</h1>
	<h1 style="font-size: 1.5em; text-align: center; color:white; font-family: Segoe UI">Key Features:</h1>

	<h1 style="font-size: 1em; text-align: center; color:white; font-family: Segoe UI">

	✅ AI-Powered Accuracy - Gemini 2.5 Flash model for superior text recognition

	✅ Multi-Language Support - Optimized for Thai, English, and 100+ languages

	✅ Privacy First - All processing happens locally, your images never leave your device

	✅ Format Preservation - Maintains original text structure and formatting

	✅ Multiple File Types - Supports PNG, JPG, JPEG, PDF, and more

	✅ Real-time Processing - Fast extraction with live progress indicators

	✅ Responsive Design - Works perfectly on desktop and mobile devices

	</h1>
	</details>
	<hr>

	<details id="▼-capabilities">

	<summary style="font-size: 2.25em; font-family: font-family: Segoe UI"><strong>🎨 Capabilities</strong></summary>

	<hr>
	<h1>

	## Luna OCR excels in various document processing scenarios..
	<p style="font-size: 2em; font-family: font-family: Segoe UI"><strong>You can achieve professional results with all these examples.</strong></p>
	<hr>



	<details id="▼-documents">

	<summary style="font-size: 1.75em; font-family: monospace"><strong>Document Processing 📄</strong></summary>

	<h1>

	Perfect for:
	- Business documents
	- Academic papers
	- Legal contracts
	- Technical manuals
	- Multi-page PDFs

	Features:
	- Page-by-page processing
	- Table structure preservation
	- Header/footer recognition
	- Formatting maintenance

	# <center>Luna OCR</center>


	</h1>
	</details>
	<hr>

	<details id="▼-thai">

	<summary style="font-size: 1.75em; font-family: monospace"><strong>Thai Language Support 🇹🇭</strong></summary>

	<h1>

	Specialized for Thai:
	- Proper word spacing
	- Context-aware processing
	- Cultural text understanding
	- Mixed Thai-English support

	Advanced Features:
	- Tone mark recognition
	- Complex character handling
	- Traditional script support
	- Modern typography processing

	# <center>Luna OCR</center>


	</h1>
	</details>
	<hr>


	<details id="▼-images">

	<summary style="font-size: 1.75em; font-family: monospace"><strong>Image Analysis 📸</strong></summary>

	<h1>

	Image Types:
	- Screenshots
	- Photographs
	- Scanned documents
	- Digital artwork with text
	- Social media posts

	Processing Power:
	- Auto-enhancement
	- Noise reduction
	- Rotation correction
	- Multi-format support

	# <center>Luna OCR</center>


	</h1>
	</details>
	<hr>

	</details>
	<hr>

	<details id="▼-examples">

	<summary style="font-size: 2.25em; font-family: Segoe UI"><strong>🏔️ Example Images</strong></summary><hr>

	<details id="▼-processing">

	<summary style="font-size: 1.75em; font-family: monospace"><strong>Processing Demo 📄</strong></summary>
	<img src="https://huggingface.co/veela4/luna_ocr/resolve/main/PDFPreview.png" alt="PDF Processing Demo">

	<h1>

	Input: Multi-page PDF documents
	Output: Structured text with preserved formatting
	Features: Table recognition, header/footer handling

	# LUNA OCR
	</details>
	<hr>

	<details id="▼-outputs">

	<summary style="font-size: 1.75em; font-family: monospace"><strong>Output Formats �</stronsg></summary>

	<img src="https://huggingface.co/veela4/luna_ocr/resolve/main/RAWText.png" alt="Text Output">

	Available Formats:
	- Plain Text (clean, readable)
	- Markdown (structured with tables)
	- JSON (structured data)
	- HTML (styled output)

	Export Options:
	- Copy to clipboard
	- Download as file
	- Direct editing

	# LUNA OCR
	</details>

	</details>
	<hr>
	</h1>

	<details id="▼-installation">
	<summary style="font-size: 2.25em; font-family: Segoe UI"><strong>💡 Installation</strong></summary>
	<hr>
	<h1><strong>

	## Quick Start Guide

	```bash
	# Clone the repository
	git clone https://huggingface.co/veela4/luna_ocr
	cd luna_ocr

	# Install dependencies
	npm install
	cd server && npm install && cd ..

	# Start the application
	npm start
	```

	## Requirements
	- Node.js 18+
	- NPM or Yarn
	- Modern web browser
	- Gemini API key (free from Google AI Studio)

	## Access Points
	- Frontend: http://localhost:3000
	- Backend: http://localhost:3002
	- Health Check: http://localhost:3002/api/health

	</strong>
	</h1>
	</details>

	<hr>

	<details id="▼-credits">

	<summary style="font-size: 2.25em; font-family: Segoe UI"><strong>📝 Credits</strong></summary>
	<hr>
	<h1><strong>
	Luna OCR is built with cutting-edge technologies and open-source libraries.

	<p>AI Model: <a href="https://ai.google.dev/">Google Gemini 2.5</a> - Advanced multimodal AI</p>
	<p>Frontend: <a href="https://react.dev/">React 19</a> - Modern UI framework</p>
	<p>Backend: <a href="https://nodejs.org/">Node.js</a> + <a href="https://expressjs.com/">Express</a> - Server infrastructure</p>
	<p>3D Graphics: <a href="https://threejs.org/">Three.js</a> - WebGL animations</p>
	<p>UI Components: <a href="https://www.radix-ui.com/">Radix UI</a> - Accessible components</p>
	<p>Animations: <a href="https://www.framer.com/motion/">Framer Motion</a> - Smooth transitions</p>

	Special thanks to the open-source community for making this project possible.
	</strong>
	</h1>
	</details>

	<hr>


	# License
	This application is open source and available under the MIT License.
	The MIT License specifies:

	```
	1. You can use, copy, modify but aren't subject to any illegal activites or selling this product
	2. The software is provided "as is", without warranty of any kind
	3. Authors are not liable for any claim, damages or other liability
	4. You must include the original copyright notice and license in all copies
	```

	[Please read the full license here](https://opensource.org/licenses/MIT)

	You're free to use Luna OCR for License purpose, for commercial applications please contact.


	<hr>

	\| Allowed \| Permission \|
	\|:-------:\|-----------------------------------------------------\|
	\| 🌙 \| Use for personal projects \|
	\| 🌙 \| Use for commercial applications \|
	\| 🌙 \| Modify and distribute \|
	\| 🌙 \| Create derivative works \|
	\| 🌙 \| Private use \|
	\| 🌙 \| Patent use \|

	# Disclaimer
	```
	Luna OCR processes images locally and does not store any user data.
	API keys are encrypted and stored locally on your device.
	The application requires a Gemini API key for text processing functionality.
	Users are responsible for complying with applicable laws and regulations when processing documents.
	```