Add Quick Preview section and cross-platform launch scripts for easy application preview #12
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds a prominent Quick Preview section to the README and creates cross-platform launch scripts that automatically set up and launch the ChairShare application with a single command. This makes it significantly easier for users, contributors, and stakeholders to quickly view the application without going through the full setup process.
Changes Made
1. 🚀 Quick Preview Section in README
Added a new prominent section at the top of the README (after the title, before Quick Start) that provides:
Clickable badge buttons with professional styling that link to:
Platform-specific launch instructions for:
./preview.shpreview.bat.\preview.ps1Clear "What happens" list explaining the automated process:
2. 🖥️ Cross-Platform Launch Scripts
Created three platform-specific preview scripts with full automation:
preview.sh (Linux/macOS)
Bash script with colored terminal output that:
node_modulesis missingopen,xdg-open, andgnome-open)preview.bat (Windows Command Prompt)
Windows batch file that:
netstatandtaskkillfor port managementpreview.ps1 (Windows PowerShell)
Modern PowerShell script that:
Get-NetTCPConnectionfor port detection3. 📘 Preview Guide Documentation
Created
PREVIEW_GUIDE.mdwith comprehensive documentation including:User Experience Improvement
Before: Users had to manually:
npm installnpm startAfter: Users run a single command and everything happens automatically with clear feedback at each step.
Screenshot
The new Quick Preview section in the README with professional badges and clear instructions:
Testing
Files Changed
README.md- Added Quick Preview section with badgespreview.sh- Linux/macOS launch script (executable)preview.bat- Windows Command Prompt launch scriptpreview.ps1- Windows PowerShell launch scriptPREVIEW_GUIDE.md- Comprehensive preview documentationBenefits
This enhancement makes ChairShare more accessible by:
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
binaries.prisma.shnode scripts/postinstall.js(dns block)node /home/REDACTED/work/SpareChair/SpareChair/node_modules/prisma/build/index.js generate --postinstall "UNABLE_TO_FIND_POSTINSTALL_TRIGGER__ENVAR_MISSING"(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.