Skip to content

Commit 3f80d4a

Browse files
authored
Merge pull request #31 from dev-phantom/docs/installation-troubleshooting-update
Docs/installation troubleshooting update
2 parents 7df1e8c + dda94ca commit 3f80d4a

76 files changed

Lines changed: 1259 additions & 95 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ coverage/
3737
*.tsbuildinfo
3838

3939
# Logs
40-
logs/
40+
4141
*.log
4242
npm-debug.log*
4343
yarn-debug.log*

assets/client/logo.png

-4.35 MB
Loading

assets/client/splash-screen.png

-4.38 MB
Binary file not shown.

assets/logos/jetstart-logo-1.png

-1.11 MB
Binary file not shown.

assets/logos/jetstart-logo-2.png

-931 KB
Binary file not shown.
-497 KB
Binary file not shown.
-1.05 MB
Binary file not shown.

assets/logos/logo.png

377 KB
Loading

docs/docs/getting-started/installation.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -309,12 +309,36 @@ export PATH=~/.npm-global/bin:$PATH
309309

310310
### Command Not Found
311311

312-
**Issue:** `jetstart: command not found` after installation
312+
**Issue:** `jetstart: command not found` or `The term 'jetstart' is not recognized`
313+
314+
:::note PowerShell Users
315+
If you see **"The command jetstart was not found, but does exist in the current location"**, it means you are in the project folder but the global command is not in your PATH. You can:
316+
- Run the local script: `.\jetstart`
317+
- Or fix your PATH to use the global command (recommended below)
318+
:::
313319

314320
**Solution:**
315-
1. Check npm global bin path: `npm bin -g`
316-
2. Add it to your PATH environment variable
317-
3. Restart your terminal
321+
1. **Find your npm global path:**
322+
```bash
323+
npm config get prefix
324+
```
325+
- **Windows:** Usually `%APPDATA%\npm` (e.g., `C:\Users\<User>\AppData\Roaming\npm`)
326+
- **macOS/Linux:** Often `/usr/local` or `~/.npm-global`
327+
328+
2. **Add to PATH:**
329+
- **Windows:**
330+
- Search for "Edit the system environment variables"
331+
- Click "Environment Variables"
332+
- Under "User variables", find `Path` and click "Edit"
333+
- Click "New" and add the path from step 1
334+
- Click OK to save
335+
- **macOS/Linux:**
336+
- Add this to your shell config (`.zshrc` or `.bashrc`):
337+
```bash
338+
export PATH=$PATH:$(npm config get prefix)/bin
339+
```
340+
341+
3. **Restart your terminal** for changes to take effect.
318342

319343
### Java Not Detected
320344

docs/docs/getting-started/introduction.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,17 @@ This intelligent approach gives you the speed of instant reload when possible, w
2222
- **⚡ Sub-100ms Hot Reload** - See UI changes instantly on your device
2323
- **🎨 Real Kotlin Compose** - Write actual Compose code, not configuration files
2424
- **📱 QR Code Setup** - Connect your device by scanning a QR code
25+
- **📡 Completely Wireless** - No USB cables or ADB required. Works effortlessly over WiFi and Hotspot
2526
- **🔄 Automatic Builds** - Smart Gradle integration with build caching
2627
- **🌐 WebSocket Communication** - Real-time updates via WebSocket protocol
2728
- **🛠️ CLI Tools** - Simple command-line interface with 6 powerful commands
2829
- **🔒 Session Isolation** - Secure, isolated development sessions
2930
- **🌍 Web Emulator** - Preview your app in the browser
3031

32+
:::tip No Cables Utility
33+
JetStart is designed to be **completely wireless**. You don't need Android Studio, ADB, or USB drivers installed. Just connect your phone and computer to the same **WiFi** or **Hotspot**, scan the QR code, and start building!
34+
:::
35+
3136
## How It Works
3237

3338
```mermaid

0 commit comments

Comments
 (0)