https://github.com/deadcoder0904/electron-ocr-baml
Electron + OCR + BAML
https://github.com/deadcoder0904/electron-ocr-baml
Last synced: 4 months ago
JSON representation
Electron + OCR + BAML
- Host: GitHub
- URL: https://github.com/deadcoder0904/electron-ocr-baml
- Owner: deadcoder0904
- Created: 2025-06-11T18:57:29.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-07-20T10:25:41.000Z (7 months ago)
- Last Synced: 2025-07-20T12:14:00.952Z (7 months ago)
- Language: TypeScript
- Size: 490 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Electron OCR with BAML
**Electron OCR with BAML** is a groundbreaking desktop app for Optical Character Recognition (OCR), built with Electron and BAML. It offers offline text extraction from images containing quotes with authors.
## Overview
This cross-platform Electron app enables offline OCR, extracting text from images containing quotes.
BAML integration makes prompt engineering simple with local testing.
## Technology Stack
- **[Electron](https://www.electronjs.org/)**: Cross-platform desktop app framework.
- **[Vite](https://vite.dev/)**: Fast build tool and dev server.
- **[TypeScript](https://www.typescriptlang.org/)**: Typed JavaScript for robust code.
- **[React](https://react.dev/)**: Dynamic UI library.
- **[BAML](https://www.boundaryml.com/)**: Customizable OCR workflow language.
## Installation
Use [Bun](https://bun.sh) for package management to set up the project:
```bash
# Install dependencies
$ bun install
# Run in development mode
$ bun run dev
# Build for distribution
# Windows
$ bun run build:win
# macOS
$ bun run build:mac
# Linux
$ bun run build:linux
```
## Resources
Explore the tech behind the project:
- [Electron Docs](https://www.electronjs.org/docs)
- [Vite Guide](https://vite.dev/guide/)
- [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/intro.html)
- [React Docs](https://react.dev)
- [BAML Overview](https://docs.boundaryml.com/)