mirror of
https://github.com/Llewellynvdm/nativefier.git
synced 2024-09-22 17:49:02 +00:00
101 lines
3.7 KiB
Markdown
101 lines
3.7 KiB
Markdown
# Nativefier
|
|
|
|
|
|
|
|
You want to make a native-looking wrapper for WhatsApp Web (or any web page).
|
|
|
|
```bash
|
|
nativefier 'web.whatsapp.com'
|
|
```
|
|
|
|
|
|
|
|
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](https://www.electronjs.org/)
|
|
(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](https://news.ycombinator.com/item?id=10930718)). Nativefier features:
|
|
|
|
- Automatically retrieval of app icon / name
|
|
- Injection of custom JS & CSS
|
|
- Many more, see the [API docs](API.md) or `nativefier --help`
|
|
|
|
## Installation
|
|
|
|
Install Nativefier globally with `npm install -g nativefier` . Requirements:
|
|
|
|
- macOS 10.10+ / Windows / Linux
|
|
- [Node.js](https://nodejs.org/) ≥ 12.9 and npm ≥ 6.9
|
|
|
|
Optional dependencies:
|
|
|
|
- [ImageMagick](http://www.imagemagick.org/) or [GraphicsMagick](http://www.graphicsmagick.org/) to convert icons.
|
|
Be sure `convert` + `identify` or `gm` are in your `$PATH`.
|
|
- [Wine](https://www.winehq.org/) to build Windows apps from non-Windows platforms.
|
|
Be sure `wine` is in your `$PATH`.
|
|
|
|
<details>
|
|
<summary>Or install with Docker (click to expand)</summary>
|
|
|
|
- Pull the image from [Docker Hub](https://hub.docker.com/r/nativefier/nativefier): `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`,
|
|
|
|
```bash
|
|
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,
|
|
|
|
```bash
|
|
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/
|
|
```
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Or install with Snap & AUR (click to expand)</summary>
|
|
|
|
These repos are *not* managed by Nativefier maintainers; use at your own risk.
|
|
If using them, for your security, please inspect the build script.
|
|
|
|
- [Snap](https://snapcraft.io/nativefier)
|
|
- [AUR](https://aur.archlinux.org/packages/nodejs-nativefier)
|
|
</details>
|
|
|
|
## Usage
|
|
|
|
To create a 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 docs](API.md) or run `nativefier --help`**
|
|
to learn about command-line flags usable to configure your app.
|
|
contribute to the [icon repository](https://github.com/nativefier/nativefier-icons).
|
|
|
|
## Troubleshooting
|
|
|
|
See [CATALOG.md](CATALOG.md) for site-specific ideas & workarounds contributed by the
|
|
community, and search in [existing issues](https://github.com/nativefier/nativefier/issues).
|
|
|
|
## Development
|
|
|
|
Help welcome on [bugs](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and
|
|
[feature requests](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request)!
|
|
|
|
Docs: [Developer / build / hacking](HACKING.md), [API / flags](API.md),
|
|
[Changelog](CHANGELOG.md).
|
|
|
|
License: [MIT](LICENSE.md).
|