Skip to content

Latest commit

 

History

History
183 lines (149 loc) · 10.8 KB

README_EN.md

File metadata and controls

183 lines (149 loc) · 10.8 KB
Raw

中文 | English

Pake

A simple way to package a web page to desktop application, supporting Mac / Windows / Linux, app download、command line one-click packaging、custom development can be found in the following documents, welcome to Discussions to see if there have anything you interesting.

Features

🏂 Small：Nearly 40 times smaller than Electron package, less than 3M.
😂 Fast：Using the Rust Tauri, the performance experience is much lighter and faster than JS, memory is much smaller.
🩴 Special：Not just packaged, with shortcut pass-through, immersive windows, minimalist customization of products.
🐶 Toy：Just a very simple little toy, a way to play with Rust instead of the old idea of shelling the web.

Download

WeRead Mac Linux Windows Twitter Mac Linux Windows
ChatGPT Mac Linux Windows Qwerty Mac Linux Windows
Code Mac Linux Windows Reference Mac Linux Windows
YouTube Mac Linux Windows Flomo Mac Linux Windows

Note: it cannot be installed to C:\Program File under Windows, and it will crash directly. It is recommended to install to other non-administrator directories, such as D:\Program Files (x86).

Command line packing



Pake provides a command line tool that makes it quicker and easier to customize the packages you need, as detailed in documentation.

// Install with npm
npm install -g pake-cli

// Command usage
pake url [options]

// Play casually, first time due to the installation environment will be a little slow
pake https://weekly.tw93.fun --name Weekly --transparent

If you are a little white who doesn't know how to use the command line, a good option is to use GitHub Actions online compilation, see the tutorial.

Shortcuts

Mac Windows/Linux Function
⌘ + [ Ctrl + ← Return to the previous page
⌘ + ] Ctrl + → Go to the next page
⌘ + ↑ Ctrl + ↑ Auto scroll to top of page
⌘ + ↓ Ctrl + ↓ Auto scroll to bottom of page
⌘ + r Ctrl + r Refresh Page
⌘ + w Ctrl + w Hide window, not quite
⌘ + - Ctrl + - Zoom out the page
⌘ + + Ctrl + + Zoom in the page
⌘ + = Ctrl + = Zoom in the Page
⌘ + 0 Ctrl + 0 Reset the page zoom

In addition, it supports double clicking the head to switch to full screen, and dragging the head to move the window

Development

Refer to the Tauri documentation to quickly configure your environment before you start.

// Install Dependencies
npm i

// Local development
npm run dev

// Pack application
npm run build

New pack

  1. Modify the tauri.conf.json in the src-tauri directory to include 4 fields url, productName, icon, identifier, icon can be selected from the icons directory or downloaded from macOSicons to match the product.
  2. For window property settings, you can modify the width/height of the windows property in tauri.conf.json, whether it is fullscreen, whether it is resizable, If you want to adapt the immersive header under Mac, you can set transparent to true and then find header element and add the padding-top style.
  3. npm run dev for local debugging; npm run dev:debug to open the devtools for container debugging.
  4. npm run build can be run to package for production.

Advanced

1. How do I rewrite the style, e.g. to remove ads from the original site, or even redesign it?

First, open devtools debug mode with npm run dev:debug. After that, find the name of the style you want to change and verify the effect in devtools, and find the location of the style in pake.js with style.innerHTML. Finally, add the style you need to override, there are some examples you can copy.

2. How to inject js code, e.g. to implement event listeners, e.g. keyboard shortcuts?

Refer to the event listener in pake.js with document.addEventListener, and write it directly, it's more of a basic front-end technique here.

3. How to communicate with Pake about events in containers, such as dragging and dropping, scrolling, special clicks on the Web, etc.?

Refer to the communication code in pake.js with postMessage, write the event listener and then use window.ipc.postMessage to pass the event and its parameters, then refer to the container to receive events window.drag_window and handle them yourself, for more information, refer to tauri and wry's official documentation.

Support

  • I have two cats, one is called TangYuan, and one is called Coke, If you think Pake makes your life better, you can give my cats feed canned food 🥩🍤.
  • If you like Pake, you can star it in Github. We are more welcome to recommend Pake to your like-minded friends.
  • You can follow my Twitter to get the latest news of Pake, or join Telegram chat group.

Finally

  1. I hope that you will enjoy playing with it and let me know if you have any new ideas.
  2. If you find a page that would be great for a Mac App, please let me know and I'll add it to the list.