Skip to content

Latest commit

 

History

History
177 lines (148 loc) · 10.8 KB

README_EN.md

File metadata and controls

177 lines (148 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're 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 Windows Linux Twitter Mac Windows Linux
LiZhi Mac Windows Linux YouTube Mac Windows Linux
Qwerty Mac Windows Linux Reference Mac Windows Linux
Library Mac Windows Linux ChatGPT Mac Windows Linux
🏂 Expand the shortcut key
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, Mac users support gesture mode to return and go to the next page, and dragging the head to move the window.

Before you start

  1. Beginner users: Use the 「Download」 method to play with Pake's capabilities, go to discussion groups for help, or try the Action method.
  2. Development users: Use 「command line packing」, Mac friendly, Windows/Linux requires a bit of tinkering, but both require environment configuration.
  3. Hacker users: If you know both front-end and rust, try the following custom development, which allows you to customize your features with deep secondary development.

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.

Development

Before starting, make sure that the computer has installed the Rust and Node environment，refer to the Tauri documentation to quickly configure your environment before you start. If you don't understand, it will be more appropriate to use the above command line to pack with one click.

// Install Dependencies
npm i

// Local development
npm run dev

// Local debug
npm run dev:debug

// Pack application
npm run build

Advanced use

  1. The code structure can be referred to Here, it is convenient for you to learn more before development.
  2. Modify the tauri.conf.json and tauri.xxx.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.
  3. 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.
  4. About style rewriting, advertising shielding, js injection, container message communication, and user-defined shortcut keys, you can see Advanced Usage of Make.

Support

  1. 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 🥩🍤.
  2. If you like Pake, you can star it in Github. Also welcome to recommend Pake to your friends.
  3. You can follow my Twitter to get the latest news of Pake, or join Telegram chat group.
  4. I hope that you will enjoy playing with it. If you find a page that would be great for a Mac App, please let me know.