README

Appifier

Appifier is an Node.js library/CLI which turns any website into Electron app.

WebCatalog no longer uses this library under the hood.

Git history prior to April 2018 is squashed. You can still find it here & here.

Requirements

macOS 10.9+, Windows 7+ or Linux.
Node.js 8+.
Yarn

Usage

To create a native desktop app for duckduckgo.com:

Command Line

Install: npm install appifier -g or yarn global add appifier

appifier --id duckduckgo --name "DuckDuckGo" --url "https://duckduckgo.com" --icon ./icon.png

Programmatic API

Install: npm install appifier or yarn add appifier

const appifier = require('appifier');

appifier.createAppAsync(
  'duckduckgo',
  'DuckDuckGo',
  'https://duckduckgo.com',
  path.resolve(__dirname, 'test', 'icon.png'),
  path.resolve(__dirname, 'dist'),
)
  .then((destPath) => {
    console.log(`App has been created at ${destPath}`);
  })
  .then((err) => {
    console.log(err);
  });

How It Works

A template Electron app is included in the ./app folder. When the appifier command or programmatic API is executed, this folder is copied to a temporary directory with the appropriate parameters in a configuration file, and is packaged into an app with electron-packager.

API Documentation

See API.

Development

See DEVELOPMENT.

Usage no npm install needed!