Go to file
Jia Hao 9078a3071a
Nativefier is unmaintained
2023-09-29 21:45:16 +08:00
.github Update to Electron 25 (#1559) 2023-08-25 09:10:05 -04:00
app Update to Electron 25.7 (#1566) 2023-08-25 14:07:42 -04:00
icon-scripts Fix icon conversion scripts broken on recent macOS (fix #1277) 2021-11-22 16:18:02 -05:00
shared Update to Electron 25 (#1559) 2023-08-25 09:10:05 -04:00
src Update to Electron 25.7 (#1566) 2023-08-25 14:07:42 -04:00
.dockerignore Docker: slim down image size, by removing temp/cache files (PR #1128) 2021-03-10 18:54:33 -05:00
.editorconfig Integrate prettier 2018-05-24 00:02:44 -07:00
.env Add playwright integration testing to the app (PR #1397) 2022-04-20 22:03:49 -04:00
.gitignore Update to Electron 25 (#1559) 2023-08-25 09:10:05 -04:00
.npmignore Actually actually (TM) include lockfile in npm artifacts 2021-09-24 22:44:07 -04:00
.npmrc Actually actually (TM) include lockfile in npm artifacts 2021-09-24 22:44:07 -04:00
.nvmrc Update to Electron 25 (#1559) 2023-08-25 09:10:05 -04:00
API.md Fix typo "electon" -> "electron" (#1492) 2023-03-24 17:07:58 -04:00
CATALOG.md CATALOG.md: Microsoft Teams with css inject (PR #1469) 2022-10-17 16:40:01 -04:00
CHANGELOG.md Update changelog for `v52.0.0` 2023-08-25 14:11:56 -04:00
Dockerfile `npm i` in the Dockerfile to esnure we have what we need to build + test (#1557) 2023-08-03 17:44:36 -04:00
HACKING.md Update Electron to 21 + Node to 16 (#1550) 2023-08-03 13:35:19 -04:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
README.md Nativefier is unmaintained 2023-09-29 21:45:16 +08:00
base-eslintrc.js Update to Electron 25 (#1559) 2023-08-25 09:10:05 -04:00
npm-shrinkwrap.json Update to Electron 25.7 (#1566) 2023-08-25 14:07:42 -04:00
package.json Update changelog for `v52.0.0` 2023-08-25 14:11:56 -04:00
tsconfig-base.json Update to Electron 25 (#1559) 2023-08-25 09:10:05 -04:00

README.md

Note: Nativefier is unmaintained, please see https://github.com/nativefier/nativefier/issues/1577.

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.13+ / Windows / Linux
  • Node.js ≥ 16.9 and npm ≥ 7.10

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 doesnt help, go look at our issue tracker.

Development

Help welcome on bugs and feature requests!

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

License: MIT.