JavaScript Shell CSS HTML
Permalink
Failed to load latest commit information.
.github Update eslint and use Airbnb style Apr 29, 2017
app Update eslint and use Airbnb style Apr 29, 2017
bin Fix bug where convert script fails silently if dependency is not found May 28, 2016
docs Update changelog for `v7.4.0` May 21, 2017
gulp Update eslint and use Airbnb style Apr 29, 2017
screenshots Fix typo Mar 27, 2016
scripts Remove quotes around changelog version Apr 29, 2017
src Fix bug resolving promises May 19, 2017
test-resources Implement injection of css Feb 25, 2016
test/module Remove Windows tests Apr 29, 2017
.codeclimate.yml Add codeclimate config May 7, 2017
.dockerignore Run Nativefier with Docker (#311) May 19, 2017
.editorconfig Add editorconfig to trim trailing whitespace Oct 9, 2016
.eslintignore Use original eslint module for linting instead of gulp May 26, 2016
.eslintrc.yml Promisfy and parallelise config, add unit tests May 7, 2017
.gitignore Use manual compiling of mocha so that sourcemaps can be used Jan 27, 2016
.hound.yml Add hound config (#369) May 19, 2017
.npmignore Do not npm ignore binaries Feb 25, 2016
.travis.yml Only release to NPM on one job Apr 29, 2017
Dockerfile Run Nativefier with Docker (#311) May 19, 2017
LICENSE.md Split docs into multiple files Mar 13, 2016
README.md Run Nativefier with Docker (#311) May 19, 2017
gulpfile.babel.js Update eslint and use Airbnb style Apr 29, 2017
package.json Update changelog for `v7.4.0` May 21, 2017
webpack.config.js Update eslint and use Airbnb style Apr 29, 2017

README.md

Nativefier

Build Status Code Climate npm version Dependency Status

Dock

You want to make a native wrapper for WhatsApp Web (or any web page).

nativefier web.whatsapp.com

Walkthrough

You're done.

Table of Contents

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, macOS 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.

Relevant Hacker News Thread

Features

  • Automatically retrieves the correct icon and app name
  • Flash Support (with --flash flag)
  • Javascript and CSS injection

Installation

Requirements

  • macOS 10.9+ / Windows / Linux
  • Node.js >=4
npm install nativefier -g

See optional dependencies for more.

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 --name "Medium" as part of the command line options, as such.

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

Read the API documentation for other command line flags and options that can be used to configure the packaged app.

If you would like high resolution icons to be used, please contribute to the icon repository!

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

For Linux Users: Do not put spaces if you define the app name yourself with --name, as this will cause problems (tested on Ubuntu 14.04) when pinning a packaged app to the launcher.

Optional Dependencies

Icons for Windows Apps from non-Windows platforms

You need Wine installed, make sure that wine is in your $PATH.

Icon Conversion for macOS

To support conversion of a .png or .ico into a .icns for a packaged macOS app icon (currently only supported on macOS), you need the following dependencies.

iconutil

You need XCode installed.

imagemagick

Make sure convert and identify are in your $PATH.

Flash

Google Chrome

Google Chrome is required for flash to be supported. Alternatively, you could download the PepperFlash Chrome plugin and specify the path to it directly with the --flash flag. See the command line options below for more details.

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.

In addition, I built GitCloud to use GitHub as an icon index, and also the pageIcon fallback to infer a relevant icon from a url.

API Documentation

See API.

Changelog

See Changelog.

Development

See Development.

Docker Image

The Dockerfile is designed that you can use it like the "normal" nativefier app. By default the command nativefier --version will be executed. Before you can use the Image you have to build it like follow:

docker build -t local/nativefier .

After that you can build your first nativefier app to the local $TARGET-PATH. Please ensure that you have write access to the $TARGET-PATH:

docker run -v $TARGET-PATH:/target local/nativefier https://my-web-app.com/ /target/

You can also use additional source or nativefier options like e.g. use a icon:

docker run -v $PATH_TO_ICON/:/src -v $TARGET-PATH:/target local/nativefier --icon /src/icon.png --name whatsApp -p linux -a x64 https://my-web-app.com/ /target/

License

MIT