2
2
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-11-16 10:05:09 +00:00
Go to file
2020-08-29 17:11:55 -04:00
.github nit 2020-07-22 21:08:07 -04:00
app Bump default Electron to 10.1.0, bump to TS 4.x 2020-08-29 16:16:25 -04:00
docs api.md: document arm64 arch 2020-08-29 16:16:25 -04:00
icon-scripts Revamp and move to TypeScript (#898) 2020-03-15 16:50:01 -04:00
src On successful build, better explain how to run the app and what to do with it (fix #1029) 2020-08-29 16:41:33 -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 v10.1.0 2020-08-29 17:11:55 -04:00
Dockerfile Restore & pimp docker docs in README, now that Docker build has been fixed by Jia (thanks Jia) (fix #848) 2020-08-10 21:33:32 -04:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
package.json Update changelog for v10.1.0 2020-08-29 17:11:55 -04:00
README.md Restore & pimp docker docs in README, now that Docker build has been fixed by Jia (thanks Jia) (fix #848) 2020-08-10 21:33:32 -04:00
tsconfig.json Emit TS type declarations, and type NativefierOptions (#1016) 2020-08-05 20:26:41 -04:00

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.

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 jiahaog/nativefier
  • ... or build the image yourself: docker build -t local/nativefier . (in this case, replace jiahaog/ 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 -v ~/nativefier-apps:/target/ jiahaog/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 -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target jiahaog/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