You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

254 lines
10 KiB

# Interview Coder - Unlocked Edition
## Free, Open-Source Alternative to Paid AI Interview Tools
This project offers a completely free alternative to premium AI interview coding tools like Interview Coder, AlgoExpert, and similar platforms. I've removed all paywalls, subscriptions, and user authentication – replacing them with a local backend that uses your own OpenAI API key.
### Why This Exists
The best coding interview tools are often behind expensive paywalls, making them inaccessible to many students and job seekers. This project provides the same powerful functionality without the cost barrier, letting you:
- Use your own API key (pay only for what you use)
- Run everything locally on your machine with complete privacy
- Make customizations to suit your specific needs
- Learn from and contribute to an open-source tool
### Customization Possibilities
The codebase is designed to be adaptable:
- **AI Models**: Though currently using OpenAI's models, you can modify the code to integrate with other providers like Claude, Deepseek, Llama, or any model with an API. All integration code is in `electron/ProcessingHelper.ts` and UI settings are in `src/components/Settings/SettingsDialog.tsx`.
- **Languages**: Add support for additional programming languages
- **Features**: Extend the functionality with new capabilities
- **UI**: Customize the interface to your preferences
All it takes is modest JavaScript/TypeScript knowledge and understanding of the API you want to integrate.
## Features
- 🎯 99% Invisibility: Undetectable window that bypasses most screen capture methods
- 📸 Smart Screenshot Capture: Capture both question text and code separately for better analysis
- 🤖 AI-Powered Analysis: Automatically extracts and analyzes coding problems using GPT-4o
- 💡 Solution Generation: Get detailed explanations and solutions with time/space complexity analysis
- 🔧 Real-time Debugging: Debug your code with AI assistance and structured feedback
- 🎨 Advanced Window Management: Freely move, resize, change opacity, and zoom the window
- 🔄 Model Selection: Choose between GPT-4o and GPT-4o-mini for different processing stages
- 🔒 Privacy-Focused: Your API key and data never leave your computer except for OpenAI API calls
## Global Commands
The application uses unidentifiable global keyboard shortcuts that won't be detected by browsers or other applications:
- Toggle Window Visibility: [Control or Cmd + B]
- Move Window: [Control or Cmd + Arrow keys]
- Take Screenshot: [Control or Cmd + H]
- Delete Last Screenshot: [Control or Cmd + L]
- Process Screenshots: [Control or Cmd + Enter]
- Reset View: [Control or Cmd + R]
- Quit: [Control or Cmd + Q]
- Decrease Opacity: [Control or Cmd + []
- Increase Opacity: [Control or Cmd + ]]
- Zoom Out: [Control or Cmd + -]
- Reset Zoom: [Control or Cmd + 0]
- Zoom In: [Control or Cmd + =]
## Invisibility Compatibility
The application is invisible to:
- Zoom versions below 6.1.6 (inclusive)
- All browser-based screen recording software
- All versions of Discord
- Mac OS _screenshot_ functionality (Command + Shift + 3/4)
Note: The application is **NOT** invisible to:
- Zoom versions 6.1.6 and above
- https://zoom.en.uptodown.com/mac/versions (link to downgrade Zoom if needed)
- Mac OS native screen _recording_ (Command + Shift + 5)
## Prerequisites
- Node.js (v16 or higher)
- npm or bun package manager
- OpenAI API Key
- Screen Recording Permission for Terminal/IDE
- On macOS:
1. Go to System Preferences > Security & Privacy > Privacy > Screen Recording
2. Ensure that Interview Coder has screen recording permission enabled
3. Restart Interview Coder after enabling permissions
- On Windows:
- No additional permissions needed
- On Linux:
- May require `xhost` access depending on your distribution
## Running the Application
### Quick Start
1. Clone the repository:
```bash
git clone https://github.com/greeneu/interview-coder-withoupaywall-opensource.git
cd interview-coder-withoupaywall-opensource
```
2. Install dependencies:
```bash
npm install
```
3. **RECOMMENDED**: Clean any previous builds:
```bash
npm run clean
```
4. Run the appropriate script for your platform:
**For Windows:**
```bash
stealth-run.bat
```
**For macOS/Linux:**
```bash
# Make the script executable first
chmod +x stealth-run.sh
./stealth-run.sh
```
**IMPORTANT**: The application window will be invisible by default! Use Ctrl+B (or Cmd+B on Mac) to toggle visibility.
**What the scripts do:**
- Create necessary directories for the application
- Clean previous builds to ensure a fresh start
- Build the application in production mode
- Launch the application in invisible mode
### Notes & Troubleshooting
- **Window Manager Compatibility**: Some window management tools (like Rectangle Pro on macOS) may interfere with the app's window movement. Consider disabling them temporarily.
- **API Usage**: Be mindful of your OpenAI API key's rate limits and credit usage. Vision API calls are more expensive than text-only calls.
- **LLM Customization**: You can easily customize the app to include LLMs like Claude, Deepseek, or Grok by modifying the API calls in `ProcessingHelper.ts` and related UI components.
- **Common Issues**:
- Run `npm run clean` before starting the app for a fresh build
- Use Ctrl+B/Cmd+B multiple times if the window doesn't appear
- Adjust window opacity with Ctrl+[/]/Cmd+[/] if needed
- For macOS: ensure script has execute permissions (`chmod +x stealth-run.sh`)
## Comparison with Paid Version of Interview Coder
| Feature | Interview Coder (Paid) | Interview Coder Unlocked (This Project) |
|---------|------------------------|----------------------------------------|
| Price | $60/month subscription | Free (only pay for your API usage) |
| Solution Generation | ✅ | ✅ |
| Debugging Assistance | ✅ | ✅ |
| Invisibility | ✅ | ✅ |
| Multi-language Support | ✅ | ✅ |
| Time/Space Complexity Analysis | ✅ | ✅ |
| Window Management | ✅ | ✅ |
| Auth System | Required | None (Simplified) |
| Payment Processing | Required | None (Use your own API key) |
| Privacy | Server-processed | 100% Local Processing |
| Customization | Limited | Full Source Code Access |
| Model Selection | Limited | Choice Between Models |
## Tech Stack
- Electron
- React
- TypeScript
- Vite
- Tailwind CSS
- Radix UI Components
- OpenAI API
## How It Works
1. **Initial Setup**
- Launch the invisible window
- Enter your OpenAI API key in the settings
- Choose your preferred model for extraction, solution generation, and debugging
2. **Capturing Problem**
- Use global shortcut [Control or Cmd + H] to take screenshots of code problems
- Screenshots are automatically added to the queue of up to 2
- If needed, remove the last screenshot with [Control or Cmd + L]
3. **Processing**
- Press [Control or Cmd + Enter] to analyze the screenshots
- AI extracts problem requirements from the screenshots using GPT-4 Vision API
- The model generates an optimal solution based on the extracted information
- All analysis is done using your personal OpenAI API key
4. **Solution & Debugging**
- View the generated solutions with detailed explanations
- Use debugging feature by taking more screenshots of error messages or code
- Get structured analysis with identified issues, corrections, and optimizations
- Toggle between solutions and queue views as needed
5. **Window Management**
- Move window using [Control or Cmd + Arrow keys]
- Toggle visibility with [Control or Cmd + B]
- Adjust opacity with [Control or Cmd + [] and [Control or Cmd + ]]
- Window remains invisible to specified screen sharing applications
- Reset view using [Control or Cmd + R]
## Adding More AI Models
This application is built with extensibility in mind. You can easily add support for additional LLMs alongside the existing OpenAI integration:
- You can add Claude, Deepseek, Grok, or any other AI model as alternative options
- The application architecture allows for multiple LLM backends to coexist
- Users can have the freedom to choose their preferred AI provider
To add new models, simply extend the API integration in `electron/ProcessingHelper.ts` and add the corresponding UI options in `src/components/Settings/SettingsDialog.tsx`. The modular design makes this straightforward without disrupting existing functionality.
## Configuration
- **OpenAI API Key**: Your personal API key is stored locally and only used for API calls to OpenAI
- **Model Selection**: You can choose between GPT-4o and GPT-4o-mini for each stage of processing:
- Problem Extraction: Analyzes screenshots to understand the coding problem
- Solution Generation: Creates optimized solutions with explanations
- Debugging: Provides detailed analysis of errors and improvement suggestions
- **Language**: Select your preferred programming language for solutions
- **Window Controls**: Adjust opacity, position, and zoom level using keyboard shortcuts
- **All settings are stored locally** in your user data directory and persist between sessions
## License
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
### What This Means
- You are free to use, modify, and distribute this software
- If you modify the code, you must make your changes available under the same license
- If you run a modified version on a network server, you must make the source code available to users
- We strongly encourage you to contribute improvements back to the main project
See the [LICENSE-SHORT](LICENSE-SHORT) file for a summary of terms or visit [GNU AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html) for the full license text.
### Contributing
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information.
## Disclaimer and Ethical Usage
This tool is intended as a learning aid and practice assistant. While it can help you understand problems and solution approaches during interviews, consider these ethical guidelines:
- Be honest about using assistance tools if asked directly in an interview
- Use this tool to learn concepts, not just to get answers
- Recognize that understanding solutions is more valuable than simply presenting them
- In take-home assignments, make sure you thoroughly understand any solutions you submit
Remember that the purpose of technical interviews is to assess your problem-solving skills and understanding. This tool works best when used to enhance your learning, not as a substitute for it.
## Support and Questions
If you have questions or need support, please open an issue on the GitHub repository.