✏️ Correction Machan

A lightweight AI-powered English correction desktop app that lives in your system tray.

---

📸 Preview

Type bad English → Press Enter → Get corrected text instantly, copied to clipboard.

---

✨ Features

• 🔔 Runs silently in the system tray — always accessible
• ⌨️ Global shortcut Ctrl+Shift+Space to open from anywhere
• 🤖 Powered by Ollama + LLaMA 3.2 running 100% locally — no internet, no API key
• 📋 Auto-copies corrected text to clipboard
• ⚡ Press Enter to correct, Shift+Enter for new line
• 🌙 Clean dark UI
• 🔒 Fully offline — your text never leaves your PC

---

🛠️ Tech Stack

Layer	Technology
Desktop Framework	Electron
UI	HTML, CSS, Vanilla JS
AI Engine	Ollama + LLaMA 3.2
Native Addon	C++ via node-addon-api
Packaging	electron-builder

---

🚀 Getting Started

Prerequisites

• Node.js v18+
• Ollama installed and running
• Windows OS
• Visual Studio 2022 Build Tools with Desktop development with C++ workload

1. Clone the repo

git clone https://github.com/yourusername/correction-machan.git
cd correction-machan

2. Install dependencies

npm install

3. Build the native addon

cd native
npm install
npx node-gyp configure build
cd ..

4. Pull the AI model

ollama pull llama3.2

5. Run the app

npm start

---

📦 Build Executable

npm run build

Output will be in dist/win-unpacked/Correction Machan.exe — run it directly or create a desktop shortcut.

---

⌨️ Keyboard Shortcuts

Shortcut	Action
Ctrl+Shift+Space	Open / Hide the app
Enter	Correct the text
Shift+Enter	New line in input

---

📁 Project Structure

correction-machan/
├── main.js                  # Electron main process (tray, window, shortcuts)
├── renderer.js              # UI logic + Ollama API calls
├── index.html               # App UI
├── package.json
├── native/
│   ├── correction_machan_native.cc   # C++ native addon
│   ├── binding.gyp                   # Build config
│   └── package.json
└── dist/                    # Built output (gitignored)

---

🤔 How It Works

1. User types English text in the app
2. On Enter / Correct button click, text is sent to Ollama's local REST API (http://localhost:11434)
3. LLaMA 3.2 corrects the grammar and spelling
4. Corrected text is displayed and auto-copied to clipboard
5. Paste it anywhere!

---

⚠️ Requirements

• Ollama must be running in the background before launching the app
• Start Ollama: just open the Ollama app or run ollama serve in terminal

---

🙌 Author

Prabodh — built with 🔥 and a lot of terminal errors

---