octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-12-23 02:28:55 +00:00
Code Issues Releases Activity
606 Commits 3 Branches 107 Tags 6.4 MiB
TypeScript 88%
JavaScript 8.6%
Shell 2.2%
Dockerfile 0.7%
CSS 0.3%
Other 0.2%
d9b3887dd1
Go to file
Varun Munjeti d9b3887dd1 Linked optional dependencies for generating icons 
It was a bit unclear that we needed those dependencies, especially if just referring to the api docs and not the main readme.
2016-09-12 14:52:13 +08:00
.github Put github files in .github 2016-02-23 21:18:58 +08:00
app add "copy link location" and "--internal-urls <regex>" features (#230) 2016-08-07 02:03:53 +08:00
bin Fix bug where convert script fails silently if dependency is not found 2016-05-28 19:22:32 +08:00
docs Linked optional dependencies for generating icons 2016-09-12 14:52:13 +08:00
gulp Use original eslint module for linting instead of gulp 2016-05-27 02:23:37 +08:00
screenshots Fix typo 2016-03-27 20:43:16 +08:00
src add "copy link location" and "--internal-urls <regex>" features (#230) 2016-08-07 02:03:53 +08:00
test/module Increase timeout for test 2016-05-26 17:12:23 +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
.eslintignore Use original eslint module for linting instead of gulp 2016-05-27 02:23:37 +08:00
.eslintrc.js Update eslint to v2.0.0 2016-05-26 23:05:44 +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 Remove support for node v0.12 and iojs 2016-05-26 17:48:02 +08:00
gulpfile.babel.js Split gulpfile into multiple parts 2016-02-28 00:45:44 +08:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
package.json 7.0.1 2016-06-16 16:30:57 +08:00
README.md Update docs to reflect node support for >=4 only 2016-05-27 00:11:24 +08:00
webpack.config.js Remove deprecated electron api from webpack config 2016-05-14 17:28:43 +08:00

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, 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 (with --flash flag)
  • Javascript and CSS injection

Installation

With Node.js >=4 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"

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

Changelog

See Changelog.

Development

See Development.

License

MIT