Shrinkray

Shrinkray

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

Features

• [x] CLI for converting static website into a macOS app.
• [x] Tiny App sizes (macOS: < 100K, Windows: N/A)
• [x] 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

<a href="https://github.com/francoislaberge/draw.io">Source code</a> (Click thumbnail to download app) </br> <a href="https://github.com/francoislaberge/draw.io/releases/download/v7.0.0/drawio.app.zip"> <img width="50%" src="http://seflless.github.io/shrinkray/images/drawio-app.png"/> </a>

Regulex

<a href="https://github.com/francoislaberge/regulex">Source code</a> (Click thumbnail to download app) </br> <a href="https://github.com/francoislaberge/regulex/releases/download/v1.0.0/regulex.app.zip"> <img width="50%" src="http://seflless.github.io/shrinkray/images/regulex-app.png"/> </a>

Mini Paint

<a href="https://github.com/francoislaberge/mini-paint">Source code</a> (Click thumbnail to download app) </br> <a href="https://github.com/francoislaberge/mini-paint/releases/download/v1.0.0/mini-paint.app.zip"> <img width="50%" src="http://seflless.github.io/shrinkray/images/mini-paint-app.png"/> </a>

Contributing

1. Required Tools

   • XCode
   • Node/NPM

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