Skip to content

PRE-RELEASE-CHECKLIST.md

Latest commit

 

History

History
265 lines (197 loc) · 6.31 KB

PRE-RELEASE-CHECKLIST.md

File metadata and controls

265 lines (197 loc) · 6.31 KB

🚀 Pre-Release Checklist - Frame Splitter v1.0.0

This checklist ensures everything is ready for the official v1.0.0 release.

✅ Project Cleanup - COMPLETED

  • Removed 13 unnecessary documentation files
  • Removed 5 utility scripts
  • Removed old release folders and artifacts
  • Fixed .gitignore configuration
  • Created PROJECT-STRUCTURE.md
  • Created CLEANUP-SUMMARY.md

✅ Package Configuration - COMPLETED

  • Updated package name: frame-splitter
  • Set version: 1.0.0
  • Updated description
  • Set author: "Kaif Ali (KF)"
  • Verified all dependencies installed
  • Electron-builder configuration correct

🎬 Icon Setup - READY

  • Created update-icon.mjs script
  • Created ICON-UPDATE-GUIDE.md
  • Dependencies installed (sharp, png-to-ico)
  • TODO: Save movie reel image as movie-reel-logo.png
  • TODO: Run node update-icon.mjs

📝 Documentation - COMPLETED

  • Main README.md (comprehensive)
  • RELEASE-NOTES-v1.0.0.md (GitHub release)
  • PROJECT-STRUCTURE.md (structure guide)
  • CLEANUP-SUMMARY.md (cleanup report)
  • ICON-UPDATE-GUIDE.md (icon instructions)
  • LICENSE file (MIT)
  • Examples folder with samples

🏗️ Build Process - READY TO TEST

Before Building:

  1. Update icon (save movie-reel-logo.png + run update-icon.mjs)
  2. Test in dev mode: npm run electron:dev
  3. Verify all features work
  4. Check file selection and frame extraction

Build Commands:

# Clean previous builds
Remove-Item -Path "dist" -Recurse -Force -ErrorAction SilentlyContinue

# Build React app
npm run build:react

# Build Windows installer
npm run build:win

Expected Output:

  • dist/Frame Splitter Setup 1.0.0.exe (installer)
  • dist/Frame Splitter 1.0.0.exe (portable)

🧪 Testing Checklist

Installation Test:

  • Run Frame Splitter Setup 1.0.0.exe
  • Install to default location
  • Check desktop shortcut created
  • Check Start Menu entry created
  • Verify icon shows movie reel logo 🎬

Application Test:

  • Launch application
  • Window opens correctly
  • UI displays properly
  • Drag & drop works
  • File browse button works

Functionality Test:

  • Select a video file
  • Button turns green + shows "File Selected"
  • Click "Split Frames"
  • Progress bar displays
  • Frames extract successfully
  • ZIP file auto-downloads
  • ZIP contains 300 frames
  • Frames are high quality

Edge Cases:

  • Test with MP4 file
  • Test with AVI file
  • Test with large video (>100MB)
  • Test with short video (<10 seconds)
  • Cancel during extraction
  • Multiple extractions in one session

📦 GitHub Release Preparation

Repository:

  • Commit all changes
  • Push to main branch
  • Check GitHub repository is up to date

Release Assets:

  • Frame Splitter Setup 1.0.0.exe (installer)
  • Frame Splitter 1.0.0.exe (portable)
  • Calculate file sizes and checksums

Release Page:

📋 Quick Build & Test Script

Run this complete workflow:

# 1. Clean previous builds
Write-Host "🧹 Cleaning previous builds..." -ForegroundColor Yellow
Remove-Item -Path "dist" -Recurse -Force -ErrorAction SilentlyContinue
Remove-Item -Path "dist-react" -Recurse -Force -ErrorAction SilentlyContinue

# 2. Update icon (if needed)
Write-Host "🎬 Updating icon..." -ForegroundColor Cyan
node update-icon.mjs

# 3. Build React app
Write-Host "⚛️  Building React app..." -ForegroundColor Cyan
npm run build:react

# 4. Build Windows app
Write-Host "🏗️  Building Windows application..." -ForegroundColor Green
npm run build:win

# 5. Show results
Write-Host "`n✅ Build Complete!" -ForegroundColor Green
Write-Host "📁 Check the dist/ folder for installers`n" -ForegroundColor White
Get-ChildItem "dist" -Filter "*.exe" | Select-Object Name, @{Name="Size (MB)";Expression={[math]::Round($_.Length/1MB, 2)}}

🎯 Current Status

✅ Ready:

  • Project structure cleaned
  • Documentation complete
  • Dependencies installed
  • Build configuration correct
  • Icon conversion tool ready

⚠️ Pending:

  1. Save movie reel logo as movie-reel-logo.png
  2. Run icon converter: node update-icon.mjs
  3. Build application: npm run build:win
  4. Test installation and functionality
  5. Create GitHub release with executables

📊 File Size Estimates

File Expected Size
Setup.exe (installer) ~150-200 MB
Portable.exe ~200-250 MB
Source code (ZIP) ~5-10 MB

🔗 Important Links

📝 Release Notes Template

For GitHub release description, use: RELEASE-NOTES-v1.0.0.md

Key points to highlight:

  • ✨ First official release
  • 🎬 Desktop app with movie reel branding
  • 🚀 Fast frame extraction (300 frames)
  • 💾 Auto ZIP download
  • 🌐 Cross-platform support
  • 📦 Easy installation

🎉 After Release

Announce on:

  • GitHub repository README
  • Social media (if applicable)
  • Developer communities
  • Friends/colleagues for feedback

Monitor:

  • GitHub Issues for bug reports
  • Download statistics
  • User feedback
  • Feature requests

Prepare for v1.1.0:

  • Collect user feedback
  • Plan new features
  • Fix any reported bugs
  • Improve documentation

🛠️ Quick Commands Reference

# Update icon
node update-icon.mjs

# Dev mode (testing)
npm run electron:dev

# Build React only
npm run build:react

# Build Windows app
npm run build:win

# Build all platforms
npm run build:all

# Clean builds
Remove-Item -Path "dist", "dist-react" -Recurse -Force

Last Updated: October 25, 2025
Status: Ready for icon update and build
Next Step: Save movie reel logo → Run update-icon.mjs → Build → Test