Skip to content

Commit 0c65f23

Browse files
KevenWMarkhamclaude
andcommitted
chore: move documentation .md files to docs directory
Moved BACKEND_QUICKSTART.md, BUILD_INSTRUCTIONS.md, ELECTRON_QUICKSTART.md, and ELECTRON_README.md to docs/ directory to keep root clean (only dev.md remains in root) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent aadae10 commit 0c65f23

File tree

4 files changed

+36
-0
lines changed

4 files changed

+36
-0
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,13 @@
2424
### 2. Start PostgreSQL
2525

2626
**Using Docker (easiest):**
27+
2728
```bash
2829
docker run --name transcript-postgres -e POSTGRES_DB=transcript_parser -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres:15-alpine
2930
```
3031

3132
**OR use existing PostgreSQL and create database:**
33+
3234
```bash
3335
createdb transcript_parser
3436
```
@@ -41,6 +43,7 @@ copy .env.example .env
4143
```
4244

4345
**Edit `.env` file** - Add your Gemini API key:
46+
4447
```env
4548
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/transcript_parser
4649
JWT_SECRET=change-this-to-random-string-minimum-32-chars
@@ -63,6 +66,7 @@ npm run dev
6366
```
6467

6568
You should see:
69+
6670
```
6771
🚀 Server running on port 3000
6872
💾 Database: Connected
@@ -83,6 +87,7 @@ copy .env.example .env
8387
```
8488

8589
File should contain:
90+
8691
```env
8792
VITE_API_URL=http://localhost:3000/api
8893
```
@@ -103,18 +108,22 @@ npm run dev
103108
## Troubleshooting
104109

105110
**Database won't connect?**
111+
106112
- Check PostgreSQL is running: `docker ps` or check service
107113
- Verify DATABASE_URL in `.env`
108114

109115
**FFmpeg error?**
116+
110117
- Run `ffmpeg -version` to verify installation
111118
- Ensure FFmpeg is in your PATH
112119

113120
**Gemini API error?**
121+
114122
- Verify API key in `.env` is correct
115123
- Check quota at https://makersuite.google.com
116124

117125
**Port 3000 in use?**
126+
118127
- Change `PORT=3001` in server `.env`
119128
- Update frontend `.env`: `VITE_API_URL=http://localhost:3001/api`
120129

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ ENOENT: no such file or directory, rename 'electron.exe' -> 'Transcript Parser.e
1515
The easiest solution is to build on a native x64 Windows machine:
1616

1717
1. **On an x64 Windows computer**, clone the repo:
18+
1819
```bash
1920
git clone https://github.com/KevenWMarkham/transcript-parser
2021
cd transcript-parser
@@ -75,6 +76,7 @@ This works perfectly on ARM64 Windows and lets you test all desktop features.
7576
**For you right now**: Use GitHub Actions (Option 2)
7677

7778
Benefits:
79+
7880
- ✅ Builds on x64 servers (no ARM issues)
7981
- ✅ Completely automated
8082
- ✅ Builds for Windows, macOS, AND Linux
@@ -87,13 +89,15 @@ I can set this up in about 5 minutes if you'd like!
8789
## 📝 Technical Details
8890

8991
**Why this happens:**
92+
9093
- You're on Windows ARM64
9194
- electron-builder uses `app-builder.exe` (ARM64 version on your machine)
9295
- app-builder ARM64 has bugs extracting x64 Electron binaries
9396
- The extraction fails silently, leaving `electron.exe` missing
9497
- Build fails when trying to rename non-existent file
9598

9699
**Your options:**
100+
97101
1. Build on x64 machine
98102
2. Use GitHub Actions (x64 cloud servers)
99103
3. Use WSL2 + Wine
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ All Electron code is written and configured. You just need to build the `.exe` f
77
## 🔨 Build the Windows .EXE
88

99
Run this command:
10+
1011
```bash
1112
npm run electron:build:win
1213
```
@@ -18,6 +19,7 @@ The build might fail with `zip: not a valid zip file`. This is a temporary netwo
1819
**Solutions:**
1920

2021
1. **Clear cache and retry:**
22+
2123
```bash
2224
npx electron-builder install-app-deps
2325
npm run electron:build:win
@@ -43,6 +45,7 @@ This launches the app in development mode with hot reload.
4345
## 📦 After Build Succeeds
4446

4547
You'll find in the `release/` folder:
48+
4649
- `Transcript Parser-Setup-1.0.0.exe` - Full installer
4750
- `Transcript Parser-Portable-1.0.0.exe` - Portable version
4851

@@ -51,6 +54,7 @@ Double-click to install and use!
5154
## 🚀 Share Your App
5255

5356
Once built, share the `.exe` file:
57+
5458
- Upload to GitHub Releases
5559
- Share via Google Drive
5660
- Email directly
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,50 +5,63 @@ Desktop version of the Transcript Parser built with Electron.
55
## Development
66

77
### Run in Development Mode
8+
89
```bash
910
npm run electron:dev
1011
```
1112

1213
This will:
14+
1315
1. Start the Vite dev server
1416
2. Wait for it to be ready
1517
3. Launch Electron pointing to the dev server
1618

1719
### Build Standalone Executables
1820

1921
#### Windows
22+
2023
```bash
2124
npm run electron:build:win
2225
```
26+
2327
Generates:
28+
2429
- `release/Transcript Parser-Setup-1.0.0.exe` - Installer
2530
- `release/Transcript Parser-Portable-1.0.0.exe` - Portable version
2631

2732
#### macOS
33+
2834
```bash
2935
npm run electron:build:mac
3036
```
37+
3138
Generates:
39+
3240
- `release/Transcript Parser-1.0.0.dmg` - DMG installer
3341
- `release/Transcript Parser-1.0.0-mac.zip` - ZIP archive
3442

3543
#### Linux
44+
3645
```bash
3746
npm run electron:build:linux
3847
```
48+
3949
Generates:
50+
4051
- `release/Transcript Parser-1.0.0.AppImage` - AppImage
4152
- `release/Transcript Parser-1.0.0.deb` - Debian package
4253
- `release/Transcript Parser-1.0.0.rpm` - RPM package
4354

4455
#### All Platforms
56+
4557
```bash
4658
npm run electron:build
4759
```
4860

4961
## Features
5062

5163
### Native Desktop Features
64+
5265
- ✅ Native file picker for video selection
5366
- ✅ Drag and drop video files
5467
- ✅ System tray integration
@@ -59,6 +72,7 @@ npm run electron:build
5972
- ✅ Auto-updates (when published to GitHub Releases)
6073

6174
### Keyboard Shortcuts
75+
6276
- `Ctrl/Cmd + O` - Open video file
6377
- `Ctrl/Cmd + Q` - Quit application
6478
- `Ctrl/Cmd + R` - Reload
@@ -68,12 +82,14 @@ npm run electron:build
6882
## Distribution
6983

7084
### GitHub Releases (Recommended)
85+
7186
1. Build all platforms: `npm run electron:build`
7287
2. Create a new GitHub Release
7388
3. Upload the executables from the `release/` folder
7489
4. Users can download and install
7590

7691
### File Sizes
92+
7793
- Windows Installer: ~150MB
7894
- macOS DMG: ~150MB
7995
- Linux AppImage: ~150MB
@@ -88,14 +104,17 @@ npm run electron:build
88104
## Troubleshooting
89105

90106
### Windows
107+
91108
- If SmartScreen blocks the app, click "More info" → "Run anyway"
92109
- For production, you should code-sign the executable
93110

94111
### macOS
112+
95113
- If "app is damaged" message appears, run: `xattr -cr "/Applications/Transcript Parser.app"`
96114
- For production, you need an Apple Developer certificate
97115

98116
### Linux
117+
99118
- Make AppImage executable: `chmod +x Transcript-Parser-1.0.0.AppImage`
100119
- Run: `./Transcript-Parser-1.0.0.AppImage`
101120

0 commit comments

Comments
 (0)