Pake/README_EN.md

中文 | English

Pake

A simple way to package a web page with Rust to create Mac App, using Tauri as underlying layer, supporting WeRead、Flomo、RunCode、ToolsFun、Witeboard、Vercel, detailed development tutorial can be seen at the bottom.

Features

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

Shortcuts

1. command + [：Return to the previous page
2. command + ]：Go to the next page
3. command + ↑：Auto scroll to top of page
4. command + ↓：Auto scroll to bottom of page
5. command + r：Refresh Page
6. command + w：Hide window, not quite
7. command + -：ZoomOut Page
8. command + =：ZoomIn Page
9. command + 0：Reset Page zoom

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

Effects

WeRead Download	Flomo Download
RunCode Download	Witeboard Download
ToolsFun Download	Vercel Download

More common apps can be downloaded from Release.

Development

Refer to the Tauri documentation to quickly configure your environment before you start, if you want to package Windows or Linux systems, you can refer to Building Documentation.

// Install Dependencies
npm i

// Local development
npm run dev

// Pack
npm run build

New pack

1. Modify the tauri.conf.json in the src-tauri directory to include 5 fields url, productName, icon, title, 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 are not good at adapting immersive headers, you can set transparent to true and you're done.
3. npm run dev for local debugging, and open the devtools comments in main.rs (search for _devtools) for container debugging.
4. npm run build can be run to package, if you have devtools mode open, remember to comment it out.

Advanced

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

1. first open devtools debug mode, find the name of the style you want to change and verify the effect in devtools first.
2. find the location of the style in pake.js with style.innerHTML and add the style you need to override, there are some examples you can copy.
3. Remember to remove the devtools comments before packaging.

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

1. Same preparation as in case 1 above.
2. 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.

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

1. the same preparation as in 1 above.
2. 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.
3. 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.

Contributors

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.