Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Shrinkray

Create desktop apps in Javascript. Lightweight alternative to Electron because of only supporting macOS (for now).

Features

  • CLI for converting static website into a macOS app.
  • Tiny App sizes (macOS: < 100K, Windows: N/A)
  • Debuggable (Right-click window, select "Inspect Element")
  • Fullscreen API
  • File Read/Write API
  • Menu API

Installation

npm install -g shrinkray

Usage

The input path must be to a folder that has an index.html in it, everything in the folder will be copied into the generated app and accessible.

shrinkray -i <project>/html -o example.app

Example Apps

Draw.io

Source code (Click thumbnail to download app)

Regulex

Source code (Click thumbnail to download app)

Mini Paint

Source code (Click thumbnail to download app)

Contributing

  1. Required Tools

  2. Clone the project

    git clone git@github.com:francoislaberge/shrinkray.git
    cd shrinkray
    
  3. Install Dependencies

    npm install
    
  4. Build App Template

    npm run build:app
    
  5. Publish to npm

    npm run publish:patch
    

About

Lightweight alternative to Electron for making macOS apps using Javascript

Resources

License

Packages

No packages published