A desktop application to help you cheat on everything.

• Node.js installed on your computer
• Git installed on your computer
• An API key from one of the supported LLM providers:
  • Gemini (from Google AI Studio)
  • OpenAI (from OpenAI Platform)

1. Clone the repository:

git clone [repository-url]
cd free-cluely

2. Install dependencies:

npm install

3. Set up environment variables:
   • Create a file named .env in the root folder
   • Configure your preferred LLM provider (see LLM_CONFIG.md for detailed instructions)
   • Example for Gemini:

   PROVIDER=gemini
   GEMINI_API_KEY=your_api_key_here
   

   • Example for OpenAI:

   PROVIDER=openai
   OPENAI_API_KEY=your_api_key_here
   

   • Save the file

1. Open a terminal and run:

npm run dev -- --port 5180

2. Open another terminal in the same folder and run:

NODE_ENV=development npm run electron:dev

npm run build

The built app will be in the release folder.

1. Closing the App:

   • Press Cmd + Q (Mac) or Ctrl + Q (Windows/Linux) to quit
   • Or use Activity Monitor/Task Manager to close Interview Coder
   • The X button currently doesn't work (known issue)

2. If the app doesn't start:

   • Make sure no other app is using port 5180
   • Try killing existing processes:

     # Find processes using port 5180
     lsof -i :5180
     # Kill them (replace [PID] with the process ID)
     kill [PID]

3. Keyboard Shortcuts:

   • Cmd/Ctrl + B: Toggle window visibility
   • Cmd/Ctrl + H: Take screenshot
   • 'Cmd/Enter': Get solution
   • Cmd/Ctrl + Arrow Keys: Move window

If you see errors:

1. Delete the node_modules folder
2. Delete package-lock.json
3. Run npm install again
4. Try running the app again using Method 1

I'm unable to maintain this repo actively because I do not have the time for it. Please do not create issues, if you have any PRs feel free to create them and i'll review and merge it.

If you are looking to integrate this for your company, i can work with you to create custom solutions.