mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-12-22 01:58:54 +00:00

Go to file

Jia Hao 67dc46adf5 Split docs into multiple files		2016-03-13 15:27:32 +08:00
.github	Put github files in `.github`	2016-02-23 21:18:58 +08:00
app	Change eslint to disallow unused variables	2016-02-28 00:49:54 +08:00
bin	Remove unnecessary `identify` dependency check	2016-03-12 15:03:13 +08:00
docs	Split docs into multiple files	2016-03-13 15:27:32 +08:00
gulp	DRY for building es6 with babel	2016-02-28 01:07:52 +08:00
screenshots	Added screenshot	2015-07-06 13:36:42 +08:00
src	Use `windows` and `osx` to specify platform	2016-03-12 16:47:18 +08:00
test/module	Rename 'pngToIcns to convertToIcns'	2016-03-10 15:50:45 +08:00
test-resources	Implement injection of css	2016-02-25 14:56:32 +08:00
.editorconfig	Initial commit for working module only with api change	2016-01-18 21:45:18 +08:00
.eslintrc.js	Allow todo in comments	2016-03-12 15:02:49 +08:00
.gitignore	Use manual compiling of mocha so that sourcemaps can be used	2016-01-27 10:24:02 +08:00
.npmignore	Do not npm ignore binaries	2016-02-25 12:27:10 +08:00
.travis.yml	Support only node 0.12 onwards	2016-03-12 02:00:00 +08:00
gulpfile.babel.js	Split gulpfile into multiple parts	2016-02-28 00:45:44 +08:00
History.md	Update changelog for `6.11.0`	2016-03-11 03:49:14 +08:00
LICENSE.md	Split docs into multiple files	2016-03-13 15:27:32 +08:00
package.json	Add progress bar	2016-03-12 15:46:07 +08:00
README.md	Split docs into multiple files	2016-03-13 15:27:32 +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

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

$ nativefier web.whatsapp.com

You're done.

Installation
Usage
Optional Dependencies
API
How It Works
Development
License

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.

Relevant Hacker News Thread

Features

Automatically retrieves the correct icon and app name
Flash Support (Needs Testing)
Javascript and CSS injection

Installation

With Node.js >=0.12 installed,

# for use from the command line
$ 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"

If you would like high resoulution 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 OSX

To support conversion of a .png or .ico into a .icns for a packaged OSX app icon (currently only supported on OSX), 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

Development

See Development

License

MIT