octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-12-31 13:11:56 +00:00
Code Issues Releases Activity
941 Commits 3 Branches 107 Tags 6.4 MiB
TypeScript 88%
JavaScript 8.6%
Shell 2.2%
Dockerfile 0.7%
CSS 0.3%
Other 0.2%
c0a6604676
Go to file
Ronan Jouchet c0a6604676
Fix considering "same domain-ish" URLs as internal (PR #1126) 
In 6b266b7815, as I got rid of deprecated dep `wurl`, I wrote:

> This one may be problematic, as it used to do TLD stuff:
> https://github.com/websanova/node-url/blob/7982a613bc/wurl.js#L4
>
> So, the new WHATWG-URL-based implementation will consider
> `asana.com` to be "external" to `app.asana.com`, contrarily to before.
> Given the nature of Nativefier, I think it's actually what to expect,
> that in this case you're "out of the app", and in e.g. asana's landing
> page, which you'd expect to see in your browser.

Turns out it's even more problematic: @TheCleric notices in https://github.com/nativefier/nativefier/pull/1124#issuecomment-790279403
that this breaks app `https://evernote.com` doing its login in `www.evernote.com`

The present change fixes this, by behaving mostly similarly to before,
but without re-introducing `wurl` or another dep needing a TLD/SLD list.
2021-03-04 10:00:53 -05:00
.github CI: avoid npm funding messages 2021-02-26 22:19:45 -05:00
app Fix considering "same domain-ish" URLs as internal (PR #1126) 2021-03-04 10:00:53 -05:00
docs Fix considering "same domain-ish" URLs as internal (PR #1126) 2021-03-04 10:00:53 -05:00
icon-scripts Icon conversion: support GraphicsMagick in addition to ImageMagick (PR #1002) 2021-02-28 14:21:28 -05:00
src Docker: fix Windows builds (fix #997), line endings, switch to Alpine (PR #1122) 2021-03-02 00:16:30 -05:00
test-resources Revamp and move to TypeScript (#898) 2020-03-15 16:50:01 -04:00
.dockerignore Docker: fix Windows builds (fix #997), line endings, switch to Alpine (PR #1122) 2021-03-02 00:16:30 -05:00
.editorconfig Integrate prettier 2018-05-24 00:02:44 -07:00
.eslintrc.js Move some tooling config (eslintignore, prettierrc) to package.json 2021-02-27 22:31:59 -05:00
.gitignore macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
.npmignore macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
.npmrc Upgrade dependencies and default to latest Electron 1.7.9 (PR #483) 2017-11-14 08:05:01 -05:00
CHANGELOG.md Update changelog for v42.3.0 2021-02-25 19:49:22 -05:00
Dockerfile Docker: fix Windows builds (fix #997), line endings, switch to Alpine (PR #1122) 2021-03-02 00:16:30 -05:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
package.json macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
README.md Icon conversion: support GraphicsMagick in addition to ImageMagick (PR #1002) 2021-02-28 14:21:28 -05:00
tsconfig.json TSConfig: bump to target/lib es2018, since we require node10 2021-02-26 22:50:59 -05:00

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 or GraphicsMagick to convert icons. Make sure convert and identify or gm 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