2
2
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-12-23 02:28:55 +00:00
Go to file
David Kramer ec1023d7ef Fix #95, #384 - Use electron-context-menu, supporting cut/copy/paste (PR #588)
The electron-context-menu package uses the context-menu event emitted by WebContents (API added in Electron 1.0.2) to add a general context menu supporting generic actions (e.g. cut/copy/paste) that can be customized. This change replaces the existing context menu, which relies on adding an event listener in preload.js, with one built using the new package.
2018-04-22 19:48:56 -04:00
.github ISSUE_TEMPLATE: Add common questions (#415) 2017-07-18 11:24:41 -04:00
app Fix #95, #384 - Use electron-context-menu, supporting cut/copy/paste (PR #588) 2018-04-22 19:48:56 -04:00
bin Fix bug where convert script fails silently if dependency is not found 2016-05-28 19:22:32 +08:00
docs Fix #364 - Add --disable-gpu flag to disable hardware acceleration (PR #584) 2018-04-22 15:56:10 -04:00
gulp Fix #480 - Move all console.* to loglevel.* calls, eslint-fail on console.* (PR #507) 2017-12-19 08:42:06 -05:00
screenshots Fix typo 2016-03-27 20:43:16 +08:00
scripts Remove quotes around changelog version 2017-04-30 02:54:47 +08:00
src Fix #94, #575: Fix run-time crash due to insufficient permissions (PR #581) 2018-04-22 16:55:46 -04:00
test/module Support Mac App Store (--mas) builds (PR #532) 2018-02-02 08:06:29 -05:00
test-resources Fix #480 - Move all console.* to loglevel.* calls, eslint-fail on console.* (PR #507) 2017-12-19 08:42:06 -05:00
.codeclimate.yml Add codeclimate config 2017-05-07 16:02:30 +08:00
.dockerignore Run Nativefier with Docker (#311) 2017-05-19 21:21:16 +08:00
.editorconfig Add editorconfig to trim trailing whitespace 2016-10-09 19:05:43 +08:00
.eslintignore Use original eslint module for linting instead of gulp 2016-05-27 02:23:37 +08:00
.eslintrc.yml Fix #480 - Move all console.* to loglevel.* calls, eslint-fail on console.* (PR #507) 2017-12-19 08:42:06 -05:00
.gitignore Upgrade dependencies and default to latest Electron 1.7.9 (PR #483) 2017-11-14 08:05:01 -05:00
.hound.yml Don't run jshint on hound 2017-08-12 11:44:00 +08:00
.npmignore Do not npm ignore binaries 2016-02-25 12:27:10 +08:00
.npmrc Upgrade dependencies and default to latest Electron 1.7.9 (PR #483) 2017-11-14 08:05:01 -05:00
.travis.yml Fix CD with Travis #482 2018-03-29 22:22:38 -07:00
Dockerfile Fix #461 & address #375 in Docker: move Dockerfile to Debian and use wine32 (#488) 2017-11-24 10:28:59 -05:00
gulpfile.babel.js Update eslint and use Airbnb style 2017-04-29 22:52:12 +08:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
package.json Update changelog for v7.6.1 2018-03-29 22:24:47 -07:00
README.md Update Dockerfile to node8-alpine, fix typos 2017-11-16 14:08:30 -05:00
webpack.config.js Upgrade dependencies and default to latest Electron 1.7.9 (PR #483) 2017-11-14 08:05:01 -05:00

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 to be used like the "normal" nativefier app. By default, the command nativefier --help 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. Ensure 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 pass nativefier flags, and mount additional volumes to provide local files. For example, to 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