381 lines
19 KiB
Markdown
381 lines
19 KiB
Markdown
<h4 align="right"><strong>English</strong> | <a href="https://github.com/tw93/Pake/blob/master/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">Pake</h1>
|
|
<p align="center"><strong>Turn any webpage into a desktop app with Rust <em>with ease</em>.</strong></p>
|
|
<div align="center">
|
|
<a href="https://twitter.com/HiTw93" target="_blank">
|
|
<img alt="twitter" src="https://img.shields.io/badge/follow-Tw93-red?style=flat-square&logo=Twitter"></a>
|
|
<a href="https://t.me/+GclQS9ZnxyI2ODQ1" target="_blank">
|
|
<img alt="telegram" src="https://img.shields.io/badge/chat-telegram-blueviolet?style=flat-square&logo=Telegram"></a>
|
|
<a href="https://github.com/tw93/Pake/releases" target="_blank">
|
|
<img alt="GitHub downloads" src="https://img.shields.io/github/downloads/tw93/Pake/total.svg?style=flat-square"></a>
|
|
<a href="https://github.com/tw93/Pake/commits" target="_blank">
|
|
<img alt="GitHub commit" src="https://img.shields.io/github/commit-activity/m/tw93/Pake?style=flat-square"></a>
|
|
<a href="https://github.com/tw93/Pake/issues?q=is%3Aissue+is%3Aclosed" target="_blank">
|
|
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/tw93/Pake.svg?style=flat-square"></a>
|
|
</div>
|
|
|
|
<div align="left">Pake supports Mac, Windows, and Linux. Check out README for <a href="#popular-packages">Popular Packages</a>, <a href="#command-line-packaging">Command-Line Packaging</a>, and <a href="#development">Customized Development</a> information. Feel free to share your suggestions in <a href=https://github.com/tw93/Pake/discussions>Discussions</a>.</div>
|
|
|
|
## Features
|
|
|
|
- 🎐 Nearly 20 times smaller than an Electron package (around 5M!)
|
|
- 🚀 With Rust Tauri, Pake is much more lightweight and faster than JS-based frameworks.
|
|
- 📦 Battery-included package — shortcut pass-through, immersive windows, and minimalist customization.
|
|
- 👻 Pake is just a simple tool — replace the old bundle approach with Rust (though PWA is good enough).
|
|
|
|
## Popular Packages
|
|
|
|
<table>
|
|
<tr>
|
|
<td>WeRead
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/WeRead.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/WeRead_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/WeRead_x86_64.deb">Linux</a>
|
|
</td>
|
|
<td>Twitter
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Twitter.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Twitter_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Twitter_x86_64.deb">Linux</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src=https://cdn.fliggy.com/upic/17dC9I.jpg width=600/></td>
|
|
<td><img src=https://cdn.fliggy.com/upic/mc41xq.jpg width=600/></td>
|
|
</tr>
|
|
<tr>
|
|
<td>ChatGPT
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/ChatGPT.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/ChatGPT_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/ChatGPT_x86_64.deb">Linux</a>
|
|
</td>
|
|
<td>Poe
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Poe.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Poe_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Poe_x86_64.deb">Linux</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src=https://cdn.fliggy.com/upic/Ld5ZCJ.png width=600/></td>
|
|
<td><img src=https://gw.alipayobjects.com/zos/k/95/bcGBut.png width=600/></td>
|
|
</tr>
|
|
<tr>
|
|
<td>YouTube Music
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/YouTubeMusic.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/YouTubeMusic_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/YouTubeMusic_x86_64.deb">Linux</a>
|
|
</td>
|
|
<td>YouTube
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/YouTube.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/YouTube_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/YouTube_x86_64.deb">Linux</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src=https://cdn.fliggy.com/upic/iz3mtQ.png width=600/></td>
|
|
<td><img src=https://gw.alipayobjects.com/zos/k/pn/1.jpg width=600/></td>
|
|
</tr>
|
|
<tr>
|
|
<td>LiZhi
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/LiZhi.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/LiZhi_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/LiZhi_x86_64.deb">Linux</a>
|
|
</td>
|
|
<td>ProgramMusic
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/ProgramMusic.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/ProgramMusic_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/ProgramMusic_x86_64.deb">Linux</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src=https://cdn.fliggy.com/upic/nYEKqN.jpg width=600/></td>
|
|
<td><img src=https://gw.alipayobjects.com/zos/k/r7/0C9lju.jpg width=600/></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Qwerty
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Qwerty.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Qwerty_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Qwerty_x86_64.deb">Linux</a>
|
|
</td>
|
|
<td>CodeRunner
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/CodeRunner.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/CodeRunner_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/CodeRunner_x86_64.deb">Linux</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src=https://cdn.fliggy.com/upic/i2eg6G.png width=600/></td>
|
|
<td><img src=https://cdn.fliggy.com/upic/mUzOek.jpg width=600/></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Flomo
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Flomo.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Flomo_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/Flomo_x86_64.deb">Linux</a>
|
|
</td>
|
|
<td>XiaoHongShu
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/XiaoHongShu.dmg">Mac</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/XiaoHongShu_x64.msi">Windows</a>
|
|
<a href="https://github.com/tw93/Pake/releases/latest/download/XiaoHongShu_x86_64.deb">Linux</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src=https://gw.alipayobjects.com/zos/k/30/RoUSUf.png width=600/></td>
|
|
<td><img src=https://gw.alipayobjects.com/zos/k/89/yJVwyi.png width=600/></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<details>
|
|
<summary>🏂 You can download more applications from <a href="https://github.com/tw93/Pake/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 quite |
|
|
| <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>=</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 |
|
|
|
|
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.
|
|
|
|
</details>
|
|
|
|
## Before starting
|
|
|
|
1. **For beginners**: Play with Popular Packages to find out Pake's capabilities, or try to pack your application with [GitHub Actions](https://github.com/tw93/Pake/wiki/Online-Compilation-(used-by-ordinary-users)). Don't hesitate to reach for assistance at [Discussion](https://github.com/tw93/Pake/discussions)!
|
|
2. **For developers**: “Command-Line Packaging” supports macOS fully. For Windows/Linux users, it requires some tinkering. [Configure your environment](https://tauri.app/v1/guides/getting-started/prerequisites) before getting started.
|
|
3. **For hackers**: For people who are good at both front-end development and Rust, how about customizing your apps' function more with the following [Customized Development](#development)?
|
|
|
|
## Command-Line Packaging
|
|
|
|
|
|
|
|
**Pake provides a command line tool, making the flow of package customization quicker and easier. See [documentation](./bin/README.md) for more information.**
|
|
|
|
```bash
|
|
# Install with npm
|
|
npm install -g pake-cli
|
|
|
|
# Command usage
|
|
pake url [OPTIONS]...
|
|
|
|
# Feel free to play with Pake! It might take a while to prepare the environment the first time you launch Pake.
|
|
pake https://weekly.tw93.fun --name Weekly --transparent
|
|
```
|
|
|
|
If you are new to the command line, you can compile packages online with _GitHub Actions_. See the [Tutorial](https://github.com/tw93/Pake/wiki/Online-Compilation-(used-by-ordinary-users)) for more information.
|
|
|
|
## Development
|
|
|
|
Prepare your environment before starting. Make sure you have Rust `>=1.63` and Node `>=16` (e.g., `16.18.1`) installed on your computer. For installation guidance, see [Tauri documentation](https://tauri.app/v1/guides/getting-started/prerequisites).
|
|
|
|
If you are unfamiliar with these, it is better to try out the above tool to pack with one click.
|
|
|
|
```sh
|
|
# Install Dependencies
|
|
npm i
|
|
|
|
# Local development [Right-click to open debug mode.]
|
|
npm run dev
|
|
|
|
# Pack application
|
|
npm run build
|
|
```
|
|
|
|
## Advanced Usage
|
|
|
|
1. You can refer to the [codebase structure](https://github.com/tw93/Pake/wiki/Description-of-Pake's-code-structure) before working on Pake, which will help you much in development.
|
|
2. Modify the `url` and `productName` fields in the `pake.json` file under the src-tauri directory, the "domain" field in the `tauri.config.json` file needs to be modified synchronously, as well as the `icon` and `identifier` fields in the `tauri.xxx.conf.json` file. You can select a `icon` from the `icons` directory or download one from [macOSicons](https://macosicons.com/#/) to match your product needs.
|
|
3. For configurations on window properties, you can modify the `pake.json` file to change the value of `width`, `height`, `fullscreen` (or not), `resizable` (or not) of the `windows` property. To adapt to the immersive header on Mac, change `transparent` to `true`, look for the `Header` element, and add the `padding-top` property.
|
|
4. For advanced usages such as style rewriting, advertisement removal, JS injection, container message communication, and user-defined shortcut keys, see [Advanced Usage of Pake](https://github.com/tw93/Pake/wiki/Advanced-Usage-of-Pake).
|
|
|
|
## Developers
|
|
|
|
Pake's development can not be without these Hackers. They contributed a lot of capabilities for Pake. Also, welcome to follow them! ❤️
|
|
|
|
<!-- readme: contributors -start -->
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/tw93">
|
|
<img src="https://avatars.githubusercontent.com/u/8736212?v=4" width="90;" alt="tw93"/>
|
|
<br />
|
|
<sub><b>Tw93</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/Tlntin">
|
|
<img src="https://avatars.githubusercontent.com/u/28218658?v=4" width="90;" alt="Tlntin"/>
|
|
<br />
|
|
<sub><b>Tlntin</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/pan93412">
|
|
<img src="https://avatars.githubusercontent.com/u/28441561?v=4" width="90;" alt="pan93412"/>
|
|
<br />
|
|
<sub><b>Pan93412</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/jeasonnow">
|
|
<img src="https://avatars.githubusercontent.com/u/16950207?v=4" width="90;" alt="jeasonnow"/>
|
|
<br />
|
|
<sub><b>Santree</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/wanghanzhen">
|
|
<img src="https://avatars.githubusercontent.com/u/25301012?v=4" width="90;" alt="wanghanzhen"/>
|
|
<br />
|
|
<sub><b>Volare</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/liby">
|
|
<img src="https://avatars.githubusercontent.com/u/38807139?v=4" width="90;" alt="liby"/>
|
|
<br />
|
|
<sub><b>Bryan Lee</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/essesoul">
|
|
<img src="https://avatars.githubusercontent.com/u/58624474?v=4" width="90;" alt="essesoul"/>
|
|
<br />
|
|
<sub><b>Essesoul</b></sub>
|
|
</a>
|
|
</td></tr>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/AielloChan">
|
|
<img src="https://avatars.githubusercontent.com/u/7900765?v=4" width="90;" alt="AielloChan"/>
|
|
<br />
|
|
<sub><b>Aiello</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/m1911star">
|
|
<img src="https://avatars.githubusercontent.com/u/4948120?v=4" width="90;" alt="m1911star"/>
|
|
<br />
|
|
<sub><b>Horus</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/Pake-Actions">
|
|
<img src="https://avatars.githubusercontent.com/u/126550811?v=4" width="90;" alt="Pake-Actions"/>
|
|
<br />
|
|
<sub><b>Pake Actions</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/QingZ11">
|
|
<img src="https://avatars.githubusercontent.com/u/38887077?v=4" width="90;" alt="QingZ11"/>
|
|
<br />
|
|
<sub><b>Steam</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/exposir">
|
|
<img src="https://avatars.githubusercontent.com/u/33340988?v=4" width="90;" alt="exposir"/>
|
|
<br />
|
|
<sub><b>孟世博</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/2nthony">
|
|
<img src="https://avatars.githubusercontent.com/u/19513289?v=4" width="90;" alt="2nthony"/>
|
|
<br />
|
|
<sub><b>2nthony</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/ACGNnsj">
|
|
<img src="https://avatars.githubusercontent.com/u/22112141?v=4" width="90;" alt="ACGNnsj"/>
|
|
<br />
|
|
<sub><b>Null</b></sub>
|
|
</a>
|
|
</td></tr>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/nekomeowww">
|
|
<img src="https://avatars.githubusercontent.com/u/11081491?v=4" width="90;" alt="nekomeowww"/>
|
|
<br />
|
|
<sub><b>Ayaka Neko</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/turkyden">
|
|
<img src="https://avatars.githubusercontent.com/u/24560160?v=4" width="90;" alt="turkyden"/>
|
|
<br />
|
|
<sub><b>Dengju Deng</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/Fechin">
|
|
<img src="https://avatars.githubusercontent.com/u/2541482?v=4" width="90;" alt="Fechin"/>
|
|
<br />
|
|
<sub><b>Fechin</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/Milo123459">
|
|
<img src="https://avatars.githubusercontent.com/u/50248166?v=4" width="90;" alt="Milo123459"/>
|
|
<br />
|
|
<sub><b>Milo</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/princemaple">
|
|
<img src="https://avatars.githubusercontent.com/u/1329716?v=4" width="90;" alt="princemaple"/>
|
|
<br />
|
|
<sub><b>Po Chen</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/houhoz">
|
|
<img src="https://avatars.githubusercontent.com/u/19684376?v=4" width="90;" alt="houhoz"/>
|
|
<br />
|
|
<sub><b>Hyzhao</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/lakca">
|
|
<img src="https://avatars.githubusercontent.com/u/16255922?v=4" width="90;" alt="lakca"/>
|
|
<br />
|
|
<sub><b>Null</b></sub>
|
|
</a>
|
|
</td></tr>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/liusishan">
|
|
<img src="https://avatars.githubusercontent.com/u/33129823?v=4" width="90;" alt="liusishan"/>
|
|
<br />
|
|
<sub><b>Liusishan</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/piaoyidage">
|
|
<img src="https://avatars.githubusercontent.com/u/5135405?v=4" width="90;" alt="piaoyidage"/>
|
|
<br />
|
|
<sub><b>Ranger</b></sub>
|
|
</a>
|
|
</td></tr>
|
|
</table>
|
|
<!-- readme: contributors -end -->
|
|
|
|
## Support
|
|
|
|
1. I have two cats, TangYuan and Coke. If you think Pake delights your life, you can feed them <a href="https://miaoyan.app/cats.html?name=Pake" target="_blank">some canned food 🥩</a>.
|
|
2. If you like Pake, you can star it on GitHub. Also, welcome to [recommend Pake](https://twitter.com/intent/tweet?url=https://github.com/tw93/Pake&text=%23Pake%20-%20A%20simple%20Rust%20packaged%20web%20pages%20to%20generate%20Mac%20App%20tool,%20compared%20to%20traditional%20Electron%20package,%20the%20size%20of%20nearly%2040%20times%20smaller,%20generally%20about%202M,%20the%20underlying%20use%20of%20Tauri,%20performance%20experience%20than%20the%20JS%20framework%20is%20much%20lighter~) to your friends.
|
|
3. You can follow my [Twitter](https://twitter.com/HiTw93) to get the latest news of Pake or join our [Telegram](https://t.me/+GclQS9ZnxyI2ODQ1) chat group.
|
|
4. I hope that you enjoy playing with it. Let us know if you find a website that would be great for a Mac App!
|