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.
Alvaro 229bc71935
CATALOG.md: WhatsApp custom CSS for native-looking app on macOS (#1468)
1 day ago
.github Bump jest to 28 (#1437) 2 months ago
app Bump default Electron to 19.0.17 (from .14), with security fixes 3 weeks ago
icon-scripts Fix icon conversion scripts broken on recent macOS (fix #1277) 11 months ago
shared macOS: universal architecture app support (fix #1384, PR #1386) 6 months ago
src Bump default Electron to 19.0.17 (from .14), with security fixes 3 weeks ago
.dockerignore Docker: slim down image size, by removing temp/cache files (PR #1128) 2 years ago
.editorconfig Integrate prettier 4 years ago
.env Add playwright integration testing to the app (PR #1397) 6 months ago
.gitignore Add playwright integration testing to the app (PR #1397) 6 months ago
.npmignore Actually actually (TM) include lockfile in npm artifacts 1 year ago
.npmrc Actually actually (TM) include lockfile in npm artifacts 1 year ago
API.md Remove arch ia32 as it's no longer supported in Electron 19 (fix #1439, PR #1441) 2 months ago
CATALOG.md CATALOG.md: WhatsApp custom CSS for native-looking app on macOS (#1468) 1 day ago
CHANGELOG.md Update changelog for `v50.0.0` 3 weeks ago
Dockerfile Docker: actually let's use *lts*-alpine, for more futureproof-ness 2 months ago
HACKING.md HACKING / major-upgrading Electron: link to blog 2 months ago
LICENSE.md Split docs into multiple files 7 years ago
README.md README: shorter 4 months ago
base-eslintrc.js Make app strict TypeScript + linting (and add a shared project) (#1231) 1 year ago
npm-shrinkwrap.json Bump default Electron to 19.0.17 (from .14), with security fixes 3 weeks ago
package.json Update changelog for `v50.0.0` 3 weeks ago
tsconfig-base.json Make app strict TypeScript + linting (and add a shared project) (#1231) 1 year ago

README.md

Nativefier

Example of Nativefier app in the macOS dock

You want to make a native-looking 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 fuss. Apps are wrapped by Electron (which uses Chromium under the hood) in an OS executable (.app, .exe, etc) usable on Windows, macOS and Linux.

I built this because I grew tired of having to Alt-Tab to my browser and then search through numerous open tabs when using Messenger or Whatsapp Web (HN thread). Nativefier features:

  • Automatically retrieval of app icon / name
  • Injection of custom JS & CSS
  • Many more, see the API docs or nativefier --help

Installation

Install Nativefier globally with npm install -g nativefier . Requirements:

  • macOS 10.10+ / Windows / Linux
  • Node.js ≥ 12.9 and npm ≥ 6.9

Optional dependencies:

  • ImageMagick or GraphicsMagick to convert icons. Be sure convert + identify or gm are in your $PATH.
  • Wine to build Windows apps from non-Windows platforms. Be sure wine is in your $PATH.
Or install with Docker (click to expand)
  • Pull the image from Docker Hub: docker pull nativefier/nativefier
  • ... or build it yourself: docker build -t local/nativefier . (in this case, replace nativefier/ in the below examples with local/)

By default, nativefier --help will be executed. To build e.g. a Gmail app into ~/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 pass local files. E.g. 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/
Or install with Snap & AUR (click to expand)

These repos are not managed by Nativefier maintainers; use at your own risk. If using them, for your security, please inspect the build script.

Usage

To create an app for medium.com, simply nativefier 'medium.com'

Nativefier will try to determine the app name, and well as other options that you can override. For example, to override the name, nativefier --name 'My Medium App' 'medium.com'

Read the API docs or run nativefier --help to learn about command-line flags and configure your app.

Troubleshooting

See CATALOG.md for site-specific ideas & workarounds contributed by the community.

If this doesn’t help, go look at our issue tracker.

Development

Help welcome on bugs and feature requests!

Docs: Developer / build / hacking, API / flags, Changelog.

License: MIT.