{"id":25864080,"url":"https://github.com/alanvww/jumpstart-electron","last_synced_at":"2026-04-19T17:04:42.753Z","repository":{"id":279348525,"uuid":"936417733","full_name":"alanvww/jumpstart-electron","owner":"alanvww","description":"A simple cross-platform Electron wrapper lets you open any URL in a dedicated window with options for kiosk mode, full screen mode, and system startup, useful for setting up creative coding projects.","archived":false,"fork":false,"pushed_at":"2025-02-25T05:18:51.000Z","size":42,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-25T05:28:27.526Z","etag":null,"topics":["creative-coding","electron","p5js","physical-computing","utility"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alanvww.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-21T03:43:04.000Z","updated_at":"2025-02-25T05:24:15.000Z","dependencies_parsed_at":"2025-02-25T05:38:52.636Z","dependency_job_id":null,"html_url":"https://github.com/alanvww/jumpstart-electron","commit_stats":null,"previous_names":["alanvww/jumpstart-electron"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanvww%2Fjumpstart-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanvww%2Fjumpstart-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanvww%2Fjumpstart-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanvww%2Fjumpstart-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alanvww","download_url":"https://codeload.github.com/alanvww/jumpstart-electron/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241444041,"owners_count":19963749,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["creative-coding","electron","p5js","physical-computing","utility"],"created_at":"2025-03-02T00:36:06.659Z","updated_at":"2025-11-25T17:04:33.437Z","avatar_url":"https://github.com/alanvww.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./icons/icon.png\" alt=\"Jumpstart Logo\" width=\"128\" height=\"128\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eJumpstart\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/alanvww/jumpstart-electron/releases/latest\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/v/release/alanvww/jumpstart-electron?style=flat-square\" alt=\"Latest Release\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nA simple cross-platform Electron wrapper lets you open any URL in a dedicated window with options for kiosk mode, full screen mode, and system startup, useful for setting up creative coding projects.\n\n## Features\n\n- **Settings Page**: Configure how the browser will run\n\n  - Enter any URL to open in the browser window\n  - Toggle kiosk mode (fullscreen without window controls)\n  - Toggle regular fullscreen mode (disabled when kiosk mode is on)\n  - Choose whether the app starts automatically with the system\n  - Set auto-refresh interval in minutes\n  - Enable automatic refresh when network reconnects\n\n- **Browser Page**: Display the specified URL\n\n  - Automatic camera and microphone permissions\n  - Exit button to return to settings\n  - Keyboard shortcut `Ctrl+Shift+Q` or `Cmd+Shift+Q` to exit kiosk mode\n  - Automatic page refresh on network reconnection\n  - Timed auto-refresh based on user settings\n\n- **Cross-Platform Support**: Works on Windows, macOS, and Linux (including Raspberry Pi)\n\n## Installation\n\n1. Go to the [Releases](https://github.com/alanvww/jumpstart-electron/releases/latest) page of this repository\n\n2. Download the appropriate version for your operating system:\n\n   - **Windows**: Download portable version (.exe)\n   - **macOS**: Download the DMG file (.dmg)\n   - **Linux**: Select the AppImage (.AppImage), Debian package (.deb), or RPM package (.rpm) - coming soon!\n\n3. Install the application:\n   - **Windows**: Extract the portable version and run the executable\n   - **macOS**: Open the DMG file and drag the application to your Applications folder\n   - **Linux**: Make the AppImage executable (`chmod +x *.AppImage`) or install the deb/rpm package using your package manager\n\n## Usage\n\n1. Launch the Jumpstart application from your applications menu or desktop\n\n2. On the settings page:\n\n   - Enter the URL you want to open (e.g., `https://example.com`)\n   - Select your desired options:\n     - **Kiosk Mode**: Fullscreen without window controls (useful for kiosks or presentations)\n     - **Fullscreen**: Regular fullscreen mode with window controls (disabled when kiosk mode is on)\n     - **Start with System**: Application will start automatically when your computer boots\n\n3. Click \"Launch Browser\" to open the specified URL\n\n4. To exit kiosk mode and return to settings:\n   - Click the \"Exit\" button in the top-right corner\n   - Press the keyboard shortcut `Ctrl+Shift+Q`(Windows), `Cmd+Shift+Q`(Mac OS)\n\n## Technical Details\n\n- Built with Electron for cross-platform compatibility\n- Uses plain JavaScript, HTML, and CSS (no additional frameworks)\n- Implements secure practices with contextIsolation and preload scripts\n- Uses Electron's IPC for communication between main and renderer processes\n- Automatically grants camera and microphone permissions for the browser page\n- Implements reliable network connectivity monitoring\n\n## Project Structure\n\n```\n├── src\n│   ├── main.js          # Electron main process\n│   ├── preload.js       # Preload script for IPC communication\n│   ├── index.html       # Settings page\n│   ├── browser.html     # Browser page\n│   └── style.css        # Styling for both pages\n├── package.json         # Dependencies and scripts\n└── README.md            # This file\n```\n\n## Cross-Platform Features\n\n### Auto-Start with System\n\nThe application supports starting automatically with the system on all major platforms:\n\n- **Windows**: Uses the Windows Registry to configure auto-start\n- **macOS**: Creates a Launch Agent in the user's Library folder\n- **Linux**: Creates a .desktop file in the autostart directory\n\n### Building for Production\n\nThe application can be built for Windows, macOS, and Linux using electron-builder, which is included as a development dependency.\n\n#### Build Commands\n\nBuild for all platforms (requires appropriate environment):\n\n```\nnpm run build:all\n```\n\nBuild for specific platforms:\n\n```\nnpm run build:win   # Windows\nnpm run build:mac   # macOS\nnpm run build:linux # Linux\n```\n\nOr just build for the current platform:\n\n```\nnpm run build\n```\n\n#### Build Outputs\n\nThe built applications will be available in the `dist` directory:\n\n- **Windows**:\n\n  - NSIS Installer (.exe)\n  - Portable version (.exe)\n\n- **macOS**:\n\n  - DMG disk image (.dmg)\n  - ZIP archive (.zip)\n\n- **Linux**:\n  - AppImage (.AppImage)\n  - Debian package (.deb)\n  - RPM package (.rpm)\n\n#### Customizing Builds\n\nYou can customize the build configuration in the `build` section of `package.json`. See the [electron-builder documentation](https://www.electron.build/) for more options.\n\n## Development\n\nIf you want to contribute to Jumpstart or build it from source, follow these steps:\n\n1. Make sure you have [Node.js](https://nodejs.org/) installed (version 14 or higher recommended)\n\n2. Clone this repository:\n\n   ```\n   git clone https://github.com/alanvww/jumpstart-electron.git\n   cd jumpstart-electron\n   ```\n\n3. Install dependencies:\n\n   ```\n   npm install\n   ```\n\n4. Start the application in development mode:\n\n   ```\n   npm start\n   ```\n\n5. Make your changes and test them\n\n6. Build the application using one of the build commands mentioned in the \"Building for Production\" section\n\n## License\n\nMIT License\n\nCopyright (c) 2025 Alan Ren\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falanvww%2Fjumpstart-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falanvww%2Fjumpstart-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falanvww%2Fjumpstart-electron/lists"}