|
| 1 | +# Coding Helper (Repo: `coding-helper`) |
| 2 | + |
| 3 | +## 👋 Introduction |
| 4 | +Coding Helper is an Electron-based desktop assistant that helps you solve coding problems by taking screenshots of problem descriptions and generating solutions using OpenAI's GPT models. It features a floating, always-on-top window with keyboard shortcuts for quick access, screenshot management, and solution rendering. |
| 5 | + |
| 6 | +## Disclaimer |
| 7 | +This is a fun, personal project intended to help you learn and experiment with coding problems. **Using this tool during interviews or assessments is at your own risk.** Please respect the rules and integrity of any platform or process you participate in. |
| 8 | + |
| 9 | +## 🔥 Demo |
| 10 | +Here is the link to the app demo. We hope you enjoy it. |
| 11 | +> [The Youtube demo Link](https://www.youtube.com/watch?v=_XNQo9AIK0Y) |
| 12 | +
|
| 13 | +## Features |
| 14 | +- **Floating Window:** Minimal, draggable overlay that stays on top of other windows. |
| 15 | +- **Quick Screenshots:** Capture up to 5 screenshots of coding problems using keyboard shortcuts. |
| 16 | +- **OpenAI Integration:** Sends screenshots to OpenAI GPT-4.1-mini for problem analysis and solution generation. |
| 17 | +- **Language Selection:** Choose your preferred programming language (Python, JavaScript, Java) for solutions. |
| 18 | +- **API Key Management:** Set and store your OpenAI API key. |
| 19 | +- **Tooltip & Settings:** Access shortcuts, language selection, and API key input via a tooltip window. |
| 20 | +- **Window Controls:** Move, show/hide, and reset the helper using keyboard shortcuts. |
| 21 | + |
| 22 | +## Getting Started |
| 23 | + |
| 24 | +### Prerequisites |
| 25 | +- [Node.js](https://nodejs.org/) (v16 or higher recommended) |
| 26 | +- [npm](https://www.npmjs.com/) |
| 27 | +- [OpenAI API Key](https://platform.openai.com/account/api-keys) |
| 28 | + |
| 29 | +### Installation |
| 30 | +1. **Clone the repository:** |
| 31 | + ```sh |
| 32 | + git clone https://github.com/yourusername/coding-helper.git |
| 33 | + cd coding-helper |
| 34 | + ``` |
| 35 | +2. open terminal/command prompt |
| 36 | + |
| 37 | +3. **Install dependencies:** |
| 38 | + ```sh |
| 39 | + npm install |
| 40 | + ``` |
| 41 | + |
| 42 | +4. **Start the app:** |
| 43 | + ```sh |
| 44 | + npm start |
| 45 | + ``` |
| 46 | + |
| 47 | +5. **Set your OpenAI API Key:** |
| 48 | + - Click the ⚙️ gear icon or use the tooltip window to enter your API key. |
| 49 | + |
| 50 | +6. **Capture the problem:** |
| 51 | + - Open Leetcode problem. |
| 52 | + - Capture up to 5 screenshots of coding problems using keyboard shortcut |
| 53 | + <kbd>⌘</kbd> + <kbd>H</kbd> (Mac) or <kbd>Ctrl</kbd> + <kbd>H</kbd> (Windows/Linux). |
| 54 | + |
| 55 | +7. **Generate Solution:** |
| 56 | + - Process <kbd>⌘</kbd> + <kbd>Enter</kbd> to generate solution. |
| 57 | + |
| 58 | +## Usage |
| 59 | +- **Take Screenshot:** <kbd>⌘</kbd> + <kbd>H</kbd> (Mac) or <kbd>Ctrl</kbd> + <kbd>H</kbd> (Windows/Linux) |
| 60 | +- **Clear Screenshots:** <kbd>⌘</kbd> + <kbd>W</kbd> |
| 61 | +- **Show/Hide Tooltip:** <kbd>⌘</kbd> + <kbd>,</kbd> |
| 62 | +- **Move Window:** <kbd>⌘</kbd> + Arrow Keys |
| 63 | +- **Show/Hide Windows:** <kbd>⌘</kbd> + <kbd>B</kbd> |
| 64 | +- **Send to OpenAI:** <kbd>⌘</kbd> + <kbd>Enter</kbd> |
| 65 | + |
| 66 | +## Project Structure |
| 67 | +``` |
| 68 | +. |
| 69 | +├── index.html |
| 70 | +├── main.js |
| 71 | +├── preload.js |
| 72 | +├── renderer.js |
| 73 | +├── solution-render.js |
| 74 | +├── solution.html |
| 75 | +├── tooltip-render.js |
| 76 | +├── tooltip.html |
| 77 | +├── package.json |
| 78 | +├── .gitignore |
| 79 | +├── screenshots/ |
| 80 | +└── .vscode/ |
| 81 | +``` |
| 82 | + |
| 83 | +## Security |
| 84 | +- Your OpenAI API key is only stored locally and never shared. |
| 85 | +- The app uses Electron's `contextIsolation` and disables `nodeIntegration` for renderer security. |
| 86 | + |
| 87 | +## License |
| 88 | +MIT |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +**Author:** Vinay Duvvada |
0 commit comments