@bghitcode/bghitapp 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tw93
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,203 @@
+<h4 align="right"><strong>English</strong> | <a href="README_CN.md">简体中文</a></h4>
+<p align="center">
+    <img src=https://gw.alipayobjects.com/zos/k/fa/logo-modified.png width=138/>
+</p>
+<h1 align="center">BghitApp</h1>
+<p align="center"><strong>Turn any webpage into a desktop app with one command — by BghitCode. Supports macOS, Windows, and Linux</strong></p>
+<div align="center">
+    <a href="https://github.com/BghitCode/bghitapp/releases" target="_blank">
+    <img alt="GitHub downloads" src="https://img.shields.io/github/downloads/BghitCode/Pake/total.svg?style=flat-square"></a>
+    <a href="https://github.com/BghitCode/bghitapp/commits" target="_blank">
+    <img alt="GitHub commit" src="https://img.shields.io/github/commit-activity/m/BghitCode/Pake?style=flat-square"></a>
+    <a href="https://github.com/BghitCode/bghitapp/issues?q=is%3Aissue+is%3Aclosed" target="_blank">
+    <img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/BghitCode/Pake.svg?style=flat-square"></a>
+</div>
+
+## Features
+
+- 🎐 **Lightweight**: Nearly 20 times smaller than Electron packages, typically around 5M
+- 🚀 **Fast**: Built with Rust Tauri, much faster than traditional JS frameworks with lower memory usage
+- ⚡ **Easy to use**: One-command packaging via CLI or online building, no complex configuration needed
+- 📦 **Feature-rich**: Supports shortcuts, immersive windows, drag & drop, style customization, ad removal
+
+## Getting Started
+
+- **Beginners**: Download ready-made [Popular Packages](#popular-packages) or use [Online Building](docs/github-actions-usage.md) with no environment setup required
+- **Developers**: Install [CLI Tool](docs/cli-usage.md) for one-command packaging of any website with customizable icons, window settings, and more
+- **Advanced Users**: Clone the project locally for [Custom Development](#development), or check [Advanced Usage](docs/advanced-usage.md) for style customization and feature enhancement
+- **Troubleshooting**: Check [FAQ](docs/faq.md) for common issues and solutions
+
+## Popular Packages
+
+<table>
+    <tr>
+        <td>WeRead
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/WeRead.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/WeRead_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/WeRead_x86_64.deb">Linux</a>
+        </td>
+        <td>Twitter
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Twitter.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Twitter_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Twitter_x86_64.deb">Linux</a>
+        </td>
+    </tr>
+    <tr>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/WeRead.jpg width=600/></td>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/Twitter.jpg width=600/></td>
+    </tr>
+    <tr>
+        <td>Grok
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Grok.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Grok_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Grok_x86_64.deb">Linux</a>
+        </td>
+        <td>DeepSeek
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/DeepSeek.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/DeepSeek_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/DeepSeek_x86_64.deb">Linux</a>
+        </td>
+    </tr>
+    <tr>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/Grok.png width=600/></td>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/DeepSeek.png width=600/></td>
+    </tr>
+    <tr>
+        <td>ChatGPT
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/ChatGPT.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/ChatGPT_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/ChatGPT_x86_64.deb">Linux</a>
+        </td>
+        <td>Gemini
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Gemini.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Gemini_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Gemini_x86_64.deb">Linux</a>
+        </td>
+    </tr>
+    <tr>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/ChatGPT.png width=600/></td>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/Gemini.png width=600/></td>
+    </tr>
+    <tr>
+      <td>YouTube Music
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/YouTubeMusic.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/YouTubeMusic_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/YouTubeMusic_x86_64.deb">Linux</a>
+      </td>
+      <td>YouTube
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/YouTube.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/YouTube_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/YouTube_x86_64.deb">Linux</a>
+      </td>
+    </tr>
+    <tr>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/YouTubeMusic.png width=600 /></td>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/YouTube.jpg width=600 /></td>
+    </tr>
+    <tr>
+        <td>LiZhi
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/LiZhi.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/LiZhi_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/LiZhi_x86_64.deb">Linux</a>
+        </td>
+        <td>ProgramMusic
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/ProgramMusic.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/ProgramMusic_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/ProgramMusic_x86_64.deb">Linux</a>
+        </td>
+    </tr>
+    <tr>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/LiZhi.jpg width=600/></td>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/ProgramMusic.jpg width=600/></td>
+    </tr>
+    <tr>
+        <td>Excalidraw
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Excalidraw.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Excalidraw_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/Excalidraw_x86_64.deb">Linux</a>
+        </td>
+        <td>XiaoHongShu
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/XiaoHongShu.dmg">Mac</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/XiaoHongShu_x64.msi">Windows</a>
+            <a href="https://github.com/BghitCode/bghitapp/releases/latest/download/XiaoHongShu_x86_64.deb">Linux</a>
+        </td>
+    </tr>
+    <tr>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/Excalidraw.png width=600/></td>
+        <td><img src=https://raw.githubusercontent.com/tw93/static/main/pake/XiaoHongShu.png width=600/></td>
+    </tr>
+</table>
+
+<details>
+<summary>🏂 You can download more applications from <a href="https://github.com/BghitCode/bghitapp/releases">Releases</a>. <b>Click here to expand the shortcuts reference!</b></summary>
+
+<br/>
+
+| Mac                                                       | Windows/Linux                                       | Function                            |
+| --------------------------------------------------------- | --------------------------------------------------- | ----------------------------------- |
+| <kbd>⌘</kbd> + <kbd>[</kbd>                               | <kbd>Ctrl</kbd> + <kbd>←</kbd>                      | Return to the previous page         |
+| <kbd>⌘</kbd> + <kbd>]</kbd>                               | <kbd>Ctrl</kbd> + <kbd>→</kbd>                      | Go to the next page                 |
+| <kbd>⌘</kbd> + <kbd>↑</kbd>                               | <kbd>Ctrl</kbd> + <kbd>↑</kbd>                      | Auto scroll to top of page          |
+| <kbd>⌘</kbd> + <kbd>↓</kbd>                               | <kbd>Ctrl</kbd> + <kbd>↓</kbd>                      | Auto scroll to bottom of page       |
+| <kbd>⌘</kbd> + <kbd>r</kbd>                               | <kbd>Ctrl</kbd> + <kbd>r</kbd>                      | Refresh Page                        |
+| <kbd>⌘</kbd> + <kbd>w</kbd>                               | <kbd>Ctrl</kbd> + <kbd>w</kbd>                      | Hide window, not quit               |
+| <kbd>⌘</kbd> + <kbd>-</kbd>                               | <kbd>Ctrl</kbd> + <kbd>-</kbd>                      | Zoom out the page                   |
+| <kbd>⌘</kbd> + <kbd>=</kbd>                               | <kbd>Ctrl</kbd> + <kbd>=</kbd>                      | Zoom in the Page                    |
+| <kbd>⌘</kbd> + <kbd>0</kbd>                               | <kbd>Ctrl</kbd> + <kbd>0</kbd>                      | Reset the page zoom                 |
+| <kbd>⌘</kbd> + <kbd>L</kbd>                               | <kbd>Ctrl</kbd> + <kbd>L</kbd>                      | Copy Current Page URL               |
+| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>⌥</kbd> + <kbd>V</kbd> | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>V</kbd>   | Paste and Match Style               |
+| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>H</kbd>                | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>H</kbd>   | Go to Home Page                     |
+| <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>I</kbd>                | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>I</kbd>   | Toggle Developer Tools (Debug Only) |
+| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>⌫</kbd>                | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Del</kbd> | Clear Cache & Restart               |
+
+In addition, double-click the title bar to switch to full-screen mode. For Mac users, you can also use the gesture to go to the previous or next page and drag the title bar to move the window. The new menu also offers options for navigation, zoom, and window controls.
+
+</details>
+
+## Command-Line Packaging
+
+![BghitApp](https://raw.githubusercontent.com/tw93/static/main/bghitapp/bghitapp1.gif)
+
+```bash
+# Install BghitApp CLI
+pnpm install -g @bghitcode/bghitapp
+
+# Basic usage - automatically fetches website icon
+bghitapp https://github.com --name GitHub
+
+# Advanced usage with custom options
+bghitapp https://example.com --name MyApp --width 1200 --height 800 --hide-title-bar
+```
+
+First-time packaging requires environment setup and may be slower, subsequent builds are fast. For complete parameter documentation, see [CLI Usage Guide](docs/cli-usage.md). Don't want to use CLI? Try [GitHub Actions Online Building](docs/github-actions-usage.md).
+
+## Development
+
+Requires Rust `>=1.85` and Node `>=22` (recommended LTS; `>=18` also works). For detailed installation guide, see [Tauri documentation](https://v2.tauri.app/start/prerequisites/). If unfamiliar with development environment, use the CLI tool instead.
+
+```bash
+# Install dependencies
+pnpm i
+
+# Local development [right-click to open debug mode]
+pnpm run dev
+
+# Build application
+pnpm run build
+```
+
+For style customization, feature enhancement, container communication and other advanced features, see [Advanced Usage Documentation](docs/advanced-usage.md).
+
+## Developers
+
+BghitApp's development can not be without these Hackers. They contributed a lot of capabilities for BghitApp. Also, welcome to follow them! ❤️
+
+<a href="https://github.com/BghitCode/bghitapp/graphs/contributors">
+  <img src="./CONTRIBUTORS.svg?v=2" alt="Contributors" width="1000" />
+</a>
+
+## Support
+
+- If BghitApp helped you, [share it](https://twitter.com/intent/tweet?url=https://github.com/BghitCode/bghitapp&text=BghitApp%20-%20Turn%20any%20webpage%20into%20a%20desktop%20app%20with%20one%20command.%20Nearly%2020x%20smaller%20than%20Electron%20packages,%20supports%20macOS%20Windows%20Linux) with friends or give it a star.
+- Got ideas or bugs? Open an issue or PR, feel free to contribute.
+- Built by <a href="https://bghitcode.com" target="_blank">BghitCode</a> — Sohail Koutari (<a href="https://github.com/reblox01" target="_blank">@reblox01</a>) — contact@bghitcode.com