various
/
Nativefier
mirror of https://github.com/jiahaog/Nativefier
1
0
Fork 0
Code Issues Releases Wiki Activity
364 Commits 2 Branches 159 Tags 17 MiB
Go to file
Jia Hao 63a539cd69 Update changelog for 2016-01-28 11:52:09 +08:00
app Cleanup 2016-01-28 11:47:40 +08:00
bin Add build step to infer and convert pngs to icns 2016-01-28 10:00:28 +08:00
screenshots Added screenshot 2015-07-06 13:36:42 +08:00
src Cleanup 2016-01-28 11:47:40 +08:00
test/module Cleanup 2016-01-28 11:47:40 +08:00
test-resources Add script to convert png to icns on osx 2016-01-27 10:22:22 +08:00
.editorconfig Initial commit for working module only with api change 2016-01-18 21:45:18 +08:00
.eslintrc.js Cleanup 2016-01-28 11:47:40 +08:00
.gitignore Use manual compiling of mocha so that sourcemaps can be used 2016-01-27 10:24:02 +08:00
.npmignore Use manual compiling of mocha so that sourcemaps can be used 2016-01-27 10:24:02 +08:00
.travis.yml Remove ci for `0.10` which causes problems with electron-prebuilt 2016-01-25 01:47:53 +08:00
CONTRIBUTING.md Add contributing 2016-01-25 09:53:09 +08:00
History.md Update changelog for 2016-01-28 11:52:09 +08:00
LICENSE Add MIT License 2016-01-19 00:15:29 +08:00
README.md Update readme for `.png` conversion 2016-01-28 11:38:58 +08:00
devNotes.md Add development notes 2016-01-26 13:30:23 +08:00
gulpfile.babel.js Cleanup 2016-01-28 11:47:40 +08:00
package.json 6.7.0 2016-01-28 11:48:39 +08:00
webpack.config.js Fix #76 where all placeholder app modules are treated as externals 2016-01-25 10:31:54 +08:00

README.md

Nativefier

Build Status npm version Dock Screenshot

You want to make a native wrapper for Google Maps (or any web page).

$ nativefier maps.google.com

You're done.

Introduction

Nativefier is a command line tool that allows you to easily create a desktop application for any web site with succinct and minimal configuration. Apps are wrapped by Electron in an OS executable (.app, .exe, etc.) for use on Windows, OSX and Linux.

I did this because I was tired of having to ⌘-tab or alt-tab to my browser and then search through the numerous open tabs when I was using Facebook Messenger or Whatsapp Web.

View the changelog here.

Installation

With Node.js installed,

# for use from the command line
$ npm install nativefier -g

Optional Dependencies

To support usage of a .png for a packaged OSX app icon, you need the following dependencies.

sips

Automatically ships with OSX

iconutil

You need XCode installed.

imagemagick

$ brew install imagemagick

Usage

Creating a native desktop app for medium.com:

$ nativefier "http://medium.com"

Nativefier will intelligently attempt to determine the app name, your OS and processor architecture, among other options. If desired, the app name or other options can be overwritten by specifying the --app-name "Medium" as part of the command line options, as such.

$ nativefier --app-name "Some Awesome App" "http://medium.com"

For Windows Users: Take note that the application menu is automatically hidden by default, you can press alt on your keyboard to access it.

Options

$ nativefier [options] <targetUrl> [dest]

Command line options are listed below.

Target Url

The url to point the application at.

[dest]

Specifies the destination directory to build the app to, defaults to the current working directory.

Help

-h, --help

Prints the usage information.

[app-name]

-n, --app-name <value>

The name of the application, which will affect strings in titles and the icon.

[platform]

-p, --platform <value>

Automatically determined based on the current OS. Can be overwritten by specifying either linux, win32, or darwin.

[arch]

-a, --arch <value>

Processor architecture, automatically determined based on the current OS. Can be overwritten by specifying either ia32 or x64.

[electron-version]

-e, --electron-version <value>

Electron version without the v, see https://github.com/atom/electron/releases.

[overwrite]

-o, --overwrite

Specifies if the destination directory should be overwritten.

[conceal]

-c, --conceal

Specifies if the source code within the nativefied app should be packaged into an archive, defaults to false, read more.

[icon]

-i, --icon <path>

Specifies a path to a .png (Windows and Linux) or a .icns (OSX) file icon for the app. If you are packing an app for OSX while on the OSX operating system, you can specify a .png instead, nativefier will automatically convert the .png to a .icns for you, provided you have sips, iconutil and imagemagick convert installed in your path. Installation steps for these optional dependencies are listed above.

Manually Obtaining .icns

The icon parameter should be a path to an .icns file. iConvertIcons can be used to convert .pngs, though it can be quite cumbersome.

To retrieve the .icns file from the downloaded file, extract it first and press File > Get Info. Then select the icon in the top left corner of the info window and press ⌘-C. Open Preview and press File > New from clipboard and save the .icns file. It took me a while to figure out how to do that and question why a .icns file was not simply provided in the downloaded archive.

Windows & Linux

The icon parameter should be a path to a .png file.

[badge]

-b, --badge

On OSX, it is desired for the App dock icon to show a badge on the receipt of a desktop notification.

There is no known way to intercept and set an event listener for a desktop notification triggered by the <webview>, the current workaround is to listen for document.title changes within the <webview>. Typical web apps like Facebook Messenger will change the document.title to "John sent a message..." on the receipt of a desktop notification, and this is what we will listen for to trigger the app badge on the dock.

However, this would cause issues when the command line argument target is set to a external page which is not a single page app, because clicking on hyperlinks and switching pages would naturally change the document.title. Hence, --badge is an optional command argument that can be set by the user if the side effect of this workaround is understood.

[counter]

--counter

Use a counter that persists even with window focus for the application badge for sites that use an "(X)" format counter in the page title (i.e. Gmail). Same limitations as the badge option (above).

[width]

--width <value>

Width of the packaged application, defaults to 1280px.

[height]

--height <value>

Height of the packaged application, defaults to 800px.

[show-menu-bar]

-m, --show-menu-bar

Specifies if the menu bar should be shown.

[user-agent]

-u, --user-agent <value>

Set the user agent to run the created app with.

[honest]

--honest

By default, nativefier uses a preset user agent string for your OS and masquerades as a regular Google Chrome browser, so that sites like WhatsApp Web will not say that the current browser is unsupported.

If this flag is passed, it will not override the user agent.

[insecure]

--insecure

Forces the packaged app to ignore certificate errors.

How It Works

A template app with the appropriate event listeners and callbacks set up is included in the ./app folder. When the nativefier command 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.

Development

Setting up the project

$ git clone https://github.com/jiahaog/nativefier.git
$ cd nativefier

# Set up dependencies for the cli tool and the placeholder app
$ npm run dev-up

# Set up symlinks so that you can run `$ nativefier` for your local changes
$ npm link

After doing so, you can then run nativefier with your test parameters

$ nativefier <...>

Don't forget to compile source files (after making changes):

$ npm run build

Or you can automatically watch the files for changes with:

$ npm run watch

Notes

Tested mostly on OSX, but should work for Windows and Linux.