various
/
Nativefier
mirror of https://github.com/jiahaog/Nativefier
1
0
Fork 0
Code Issues Releases Wiki Activity
854 Commits 2 Branches 159 Tags 17 MiB
Go to file
Ronan Jouchet 8684887fc6 Bump eslint to 7.x, fix new lint errors 2020-07-18 11:19:58 -04:00
.github Bugreport issue template: add checkmark for latest version 2020-03-19 18:09:37 -04:00
app Bump eslint to 7.x, fix new lint errors 2020-07-18 11:19:58 -04:00
docs release.md: document creating & pushing npm-release-causing tag 2020-06-13 11:27:38 -04:00
icon-scripts Revamp and move to TypeScript (#898) 2020-03-15 16:50:01 -04:00
src Bump eslint to 7.x, fix new lint errors 2020-07-18 11:19:58 -04:00
test-resources Revamp and move to TypeScript (#898) 2020-03-15 16:50:01 -04:00
.dockerignore Run Nativefier with Docker (#311) 2017-05-19 21:21:16 +08:00
.editorconfig Integrate prettier 2018-05-24 00:02:44 -07:00
.eslintignore Use original eslint module for linting instead of gulp 2016-05-27 02:23:37 +08:00
.eslintrc.js Bump eslint to 7.x, fix new lint errors 2020-07-18 11:19:58 -04:00
.gitignore Fix failing to global-sudo-install due to postinstall script (fix #923) 2020-03-16 21:06:03 -04:00
.npmignore Fix failing to global-sudo-install due to postinstall script (fix #923) 2020-03-16 21:06:03 -04:00
.npmrc Upgrade dependencies and default to latest Electron 1.7.9 (PR #483) 2017-11-14 08:05:01 -05:00
.prettierrc.yaml Integrate prettier 2018-05-24 00:02:44 -07:00
.travis.yml [BREAKING CHANGE] Require Node.js >= 10 2020-06-13 10:46:27 -04:00
CHANGELOG.md Update changelog for `v9.1.0` 2020-07-18 02:19:44 -04:00
Dockerfile Simplify README, move unmaintained docker doc to Dockerfile 2020-07-18 10:19:58 -04:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
README.md README: fix links to bugs & feature requests 2020-07-18 10:30:22 -04:00
package.json Bump eslint to 7.x, fix new lint errors 2020-07-18 11:19:58 -04:00
tsconfig.json Revamp and move to TypeScript (#898) 2020-03-15 16:50:01 -04:00

README.md

Nativefier

Build Status npm version

Dock

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

nativefier web.whatsapp.com

Walkthrough animation

You're done.

Introduction

Nativefier is a command-line tool to easily create a desktop app for any web site with minimal configuration. Apps are wrapped by Electron (which uses Chromium under the hood) 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 (HN thread). Nativefier features:

  • Automatically retrieval of app icon / name.
  • JavaScript and CSS injection.
  • Many more, see the API docs or nativefier --help

Installation

  • macOS 10.9+ / Windows / Linux
  • Node.js >= 10 and npm >= 6
  • Optional dependencies:
    • ImageMagick to convert icons. Make sure convert and identify are in your system $PATH.
    • Wine to package Windows apps under non-Windows platforms. Make sure wine is in your system $PATH.
npm install -g nativefier

Usage

To create a native desktop app for medium.com, simply nativefier "medium.com"

Nativefier will try to determine the app name, and well as lots of other options. If desired, these options can be overwritten. For example, to override the name, nativefier --name 'My Medium App' 'medium.com'

Read the API documentation or run nativefier --help to learn about other command-line flags usable to configure the packaged app.

To have high-resolution icons used by default for an app/domain, please contribute to the icon repository!

Development

Help welcome on bugs and feature requests.

Developer / build docs, API documentation, Changelog.

License

MIT