@@ -82,7 +82,9 @@ Note: The application is **NOT** invisible to:
82
82
- On Linux:
83
83
- May require ` xhost ` access depending on your distribution
84
84
85
- ## Installation
85
+ ## Running the Application
86
+
87
+ ### Initial Setup
86
88
87
89
1 . Clone the repository:
88
90
@@ -95,29 +97,56 @@ cd interview-coder-unlocked
95
97
96
98
``` bash
97
99
npm install
98
- # or if using bun
99
- bun install
100
100
```
101
101
102
- 3 . Start the application:
102
+ This will install all required npm packages including Electron, React, TypeScript, and other dependencies needed for the application.
103
+
104
+ ### Running in Stealth Mode
105
+
106
+ For the best experience, follow these steps to run the application:
107
+
108
+ 1 . First, clean any previous builds:
103
109
104
110
``` bash
105
- npm run dev
111
+ npm run clean
106
112
```
107
113
108
- 4 . Enter your OpenAI API key in the settings dialog when prompted.
114
+ This command removes the ` dist ` and ` dist-electron ` directories to ensure a fresh build without any cached files or outdated components.
115
+
116
+ 2 . Then run the stealth-run batch file:
117
+
118
+ ``` bash
119
+ stealth-run.bat
120
+ ```
109
121
110
- ## Running in Production
122
+ ** What the stealth-run.bat does:**
123
+ - Creates necessary directories in your AppData folder for storing screenshots and cache
124
+ - Builds the application in production mode
125
+ - Launches the application in stealth mode (invisible by default)
126
+ - Provides a reminder of key shortcuts
111
127
112
- 1 . Build the application:
128
+ ** IMPORTANT** : When using stealth-run.bat, the application window will be invisible by default! Use Ctrl+B (or Cmd+B on Mac) to toggle visibility.
129
+
130
+ ### Troubleshooting
131
+
132
+ If you encounter any issues with the application:
133
+
134
+ 1 . Always start with a clean build:
113
135
114
136
``` bash
115
- npm run build
137
+ npm run clean
116
138
```
117
139
118
- 2 . The built application will be in the ` dist ` directory.
140
+ 2 . Make sure you have the latest dependencies:
141
+
142
+ ``` bash
143
+ npm install
144
+ ```
119
145
120
- 3 . Alternatively, you can use the provided ` stealth-run.bat ` to quickly build and launch the application.
146
+ 3 . If the window is invisible and keyboard shortcuts don't seem to work, try:
147
+ - Pressing Ctrl+B (or Cmd+B on Mac) multiple times
148
+ - Checking Task Manager/Activity Monitor to verify the application is running
149
+ - Restarting the application
121
150
122
151
## Comparison with Paid Version of Interview Coder
123
152
0 commit comments