You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ronan Jouchet 519e65e7da TSConfig: bump to target/lib es2018, since we require node10 14 hours ago
.github CI: avoid npm funding messages 15 hours ago
app TSConfig: bump to target/lib es2018, since we require node10 14 hours ago
docs Scripts: get rid of `dev-up` and `dev-up-win` scripts 14 hours ago
icon-scripts Revamp and move to TypeScript (#898) 11 months ago
src Doc extra electron update stuff 1 day ago
test-resources Revamp and move to TypeScript (#898) 11 months ago
.dockerignore Run Nativefier with Docker (#311) 3 years ago
.editorconfig Integrate prettier 2 years ago
.eslintignore Use original eslint module for linting instead of gulp 4 years ago
.eslintrc.js Bump eslint to 7.x, fix new lint errors 7 months ago
.gitignore Fix failing to global-sudo-install due to postinstall script (fix #923) 11 months ago
.npmignore Fix failing to global-sudo-install due to postinstall script (fix #923) 11 months ago
.npmrc Upgrade dependencies and default to latest Electron 1.7.9 (PR #483) 3 years ago
.prettierrc.yaml Integrate prettier 2 years ago
CHANGELOG.md Update changelog for `v42.3.0` 1 day ago
Dockerfile Move to nativefier organization 4 weeks ago
LICENSE.md Split docs into multiple files 5 years ago
README.md Move to nativefier organization 4 weeks ago
package.json Scripts: get rid of `dev-up` and `dev-up-win` scripts 14 hours ago
tsconfig.json TSConfig: bump to target/lib es2018, since we require node10 14 hours ago

README.md

Nativefier

👋 dear users / contributors! Public service announcement!

Nativefier is maintained by YOU. It’s reasonably sane to hack on nowadays, it fits the use cases needed by the original author and the current maintainer, so we are not doing any active development.

But it’s alive! It at least follows Electron releases with maintenance patches, and if YOU use it and want to see juicy features & fixes, PR welcome! Help welcome in particular on our pinned issues, or any issue / feature that motivates you 🙂.

Thanks! Take care.


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.

Then, install Nativefier globally with 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!

Usage with Docker

Nativefier is also usable from Docker.

  • Pull the latest stable image from Docker Hub: docker pull nativefier/nativefier
  • ... or build the image yourself: docker build -t local/nativefier . (in this case, replace nativefier/ in the below examples with local/)

By default, the command nativefier --help will be executed. To build e.g. a Gmail nativefier app to a writable local ~/nativefier-apps,

docker run --rm -v ~/nativefier-apps:/target/ nativefier/nativefier https://mail.google.com/ /target/

You can pass Nativefier flags, and mount volumes to provide local files. For example, to use an icon,

docker run --rm -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target nativefier/nativefier --icon /src/icon.png --name whatsApp -p linux -a x64 https://web.whatsapp.com/ /target/

Development

Help welcome on bugs and feature requests.

Developer / build docs, API documentation, Changelog.

License

MIT