Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/explicit-logic/spot-serve-gui
The desktop companion app for Spot Serve - a seamless solution for developers to share quick, interactive previews of their websites.
https://github.com/explicit-logic/spot-serve-gui
cloudflared desktop developer-tools javascript p2p peer-to-peer peerjs qrcode react react-router rust shadcn-ui tailwind-css tauri tunnel typescript vite-react webrtc
Last synced: 3 days ago
JSON representation
The desktop companion app for Spot Serve - a seamless solution for developers to share quick, interactive previews of their websites.
- Host: GitHub
- URL: https://github.com/explicit-logic/spot-serve-gui
- Owner: explicit-logic
- License: mit
- Created: 2025-01-14T03:58:17.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-02-17T09:48:30.000Z (3 days ago)
- Last Synced: 2025-02-17T10:31:33.562Z (3 days ago)
- Topics: cloudflared, desktop, developer-tools, javascript, p2p, peer-to-peer, peerjs, qrcode, react, react-router, rust, shadcn-ui, tailwind-css, tauri, tunnel, typescript, vite-react, webrtc
- Language: TypeScript
- Homepage: https://spot-serve.pages.dev/
- Size: 1.92 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Spot Serve Desktop
The desktop companion app for Spot Serve - a seamless solution for developers to share quick, interactive previews of their websites. This desktop application works in conjunction with the [Spot Serve web platform](https://github.com/yakovenkodenis/spot-serve-web) to provide a streamlined experience for sharing local website previews.
## Features
- Simple drag-and-drop interface for website files or folders
- Automatic zip compression of your website files
- One-click upload and URL generation
- System tray integration for quick access
- Real-time preview status monitoring
- Secure WebRTC-based file sharing
- Cross-platform support (Windows, macOS, Linux)
## Installation
### Download
Download the latest version for your operating system from the [releases page](https://github.com/explicit-logic/spot-serve-gui/releases).
### Build from Source
1. Clone the repository:
```bash
git clone [email protected]:explicit-logic/spot-serve-gui.git
```
2. Install dependencies:
```bash
cd spot-serve-gui
npm install
```
3. Download `cloudflared`:
```bash
npm run pull:cloudflared
```
4. Run in development mode:
```bash
npm run tauri dev
```
5. Build for your platform:
```bash
npm run tauri build
```
## Usage
1. Launch the Spot Serve desktop application
2. Either:
- Drag and drop your website folder into the application window
- Click "Select Files" to choose your website files
- Use the "Select Folder" option to choose an entire directory
3. The app will automatically compress your files and generate a shareable URL
4. Copy the generated URL and share it with your collaborators
## Integration with Spot Serve Web
This desktop application works seamlessly with the [Spot Serve web platform](https://github.com/yakovenkodenis/spot-serve-web). While the web platform handles the viewing experience, this desktop app manages the local file handling and sharing capabilities.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](LICENSE)
## Related Projects
- [Spot Serve Web Platform](https://github.com/yakovenkodenis/spot-serve-web) - The web component of Spot Serve
## Acknowledgements
* Cloudflare Tunnel: [cloudflare/cloudflared](https://github.com/cloudflare/cloudflared)
* PeerJS: [peerjs](https://peerjs.com/)