2
2
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-10-31 18:52:30 +00:00
Go to file
Octavio Ietsugu 8907b9dc97
CATALOG.md: add a new recipe for using interactive buttons on Notion (#1430)
I've used Nativefier along with Notion in the last couple days and I was able to use interactive buttons on my Notion exported page, something that was not possible originally. As such, please consider the following recipe.

Co-authored-by: Dev pop-os <dev+pop-os@mevio.com.br>
2022-07-23 17:39:00 -04:00
.github Publish: fix Docker build failing because of Playwright, and make a convenience npm task for it 2022-05-02 00:27:58 -04:00
app Bump default Electron to 18.3.5 2022-06-27 15:56:57 -04:00
icon-scripts Fix icon conversion scripts broken on recent macOS (fix #1277) 2021-11-22 16:18:02 -05:00
shared macOS: universal architecture app support (fix #1384, PR #1386) 2022-04-18 19:11:31 -04:00
src Bump default Electron to 18.3.5 2022-06-27 15:56:57 -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 Add playwright integration testing to the app (PR #1397) 2022-04-20 22:03:49 -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
API.md API.md: fix link to Electron Frameless Window (fix #1382) 2022-05-19 23:04:00 -04:00
base-eslintrc.js Make app strict TypeScript + linting (and add a shared project) (#1231) 2021-06-26 09:59:28 -04:00
CATALOG.md CATALOG.md: add a new recipe for using interactive buttons on Notion (#1430) 2022-07-23 17:39:00 -04:00
CHANGELOG.md Update changelog for v47.2.1 2022-06-27 16:01:22 -04:00
Dockerfile Publish: fix Docker build failing because of Playwright, and make a convenience npm task for it 2022-05-02 00:27:58 -04:00
HACKING.md HACKING.md: triage guidelines (PR #1338) 2022-01-31 16:23:47 -05:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
npm-shrinkwrap.json Bump default Electron to 18.3.5 2022-06-27 15:56:57 -04:00
package.json Update changelog for v47.2.1 2022-06-27 16:01:22 -04:00
README.md README: shorter 2022-05-30 12:26:05 -04:00
tsconfig-base.json Make app strict TypeScript + linting (and add a shared project) (#1231) 2021-06-26 09:59:28 -04:00

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 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.