mirror of
https://github.com/Llewellynvdm/nativefier.git
synced 2024-09-29 12:49:06 +00:00
1 line
11 KiB
JSON
1 line
11 KiB
JSON
|
{"name":"Nativefier","tagline":"Wrap any web page natively without even thinking, across Windows, OSX and Linux","body":"# Nativefier\r\n[](https://travis-ci.org/jiahaog/nativefier)\r\n[](https://www.npmjs.com/package/nativefier)\r\n[](https://codeclimate.com/github/jiahaog/nativefier)\r\n\r\n\r\n\r\nYou want to make a native wrapper for Google Maps (or any web page).\r\n\r\n```bash\r\n$ nativefier maps.google.com\r\n```\r\n\r\nYou're done.\r\n\r\n## Introduction\r\n\r\nNativefier is a command line tool that allows you to easily create a desktop application for any web site with succinct and minimal configuration. Apps are wrapped by [Electron](http://electron.atom.io) in an OS executable (`.app`, `.exe`, etc.) for use on Windows, OSX and Linux.\r\n\r\nI 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](http://messenger.com) or [Whatsapp Web](http://web.whatsapp.com).\r\n\r\nView the changelog [here](https://github.com/jiahaog/nativefier/blob/master/History.md).\r\n\r\n[Relevant Hacker News Thread](https://news.ycombinator.com/item?id=10930718)\r\n\r\n### Features\r\n\r\n- Automatically retrieves the correct icon and app name\r\n- Flash Support (Needs Testing)\r\n- Javascript and CSS injection\r\n\r\n## Installation\r\n\r\nWith [Node.js](https://nodejs.org/) installed,\r\n\r\n```bash\r\n# for use from the command line\r\n$ npm install nativefier -g\r\n```\r\n### Optional Dependencies\r\n\r\n#### `.png` to `.icns` Conversion\r\n\r\nTo support usage of a `.png` for a packaged OSX app icon (currently only supported on OSX), you need the following dependencies.\r\n\r\n##### [sips](https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/sips.1.html)\r\nAutomatically ships with OSX\r\n\r\n##### [iconutil](https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Optimizing/Optimizing.html)\r\n\r\nYou need [XCode](https://developer.apple.com/xcode/) installed.\r\n\r\n##### [imagemagick](http://www.imagemagick.org/script/index.php)\r\n\r\n```bash\r\n$ brew install imagemagick\r\n```\r\n\r\n##### [Google Chrome](https://www.google.com/chrome/)\r\n\r\nGoogle Chrome is required for flash to be supported. Alternatively, you could download the PepperFlash Chrome plugin and specify the path to it directly with the `--flash` flag. See the command line options below for more details.\r\n\r\n## Usage\r\n\r\nCreating a native desktop app for [medium.com](http://medium.com):\r\n\r\n```bash\r\n$ nativefier \"http://medium.com\"\r\n```\r\n\r\nNativefier will intelligently attempt to determine the app name, your OS and processor architecture, among other options. If desired, the app name or other options can be overwritten by specifying the `--name \"Medium\"` as part of the command line options, as such.\r\n\r\n```\r\n$ nativefier --name \"Some Awesome App\" \"http://medium.com\"\r\n```\r\n\r\n**For Windows Users:** Take note that the application menu is automatically hidden by default, you can press `alt` on your keyboard to access it.\r\n\r\n**For Linux Users:** Do not put spaces if you define the app name yourself with `--name`, as this will cause problems (tested on Ubuntu 14.04) when pinning a packaged app to the launcher.\r\n\r\n## Command Line Options\r\n\r\n```bash\r\n$ nativefier [options] <targetUrl> [dest]\r\n```\r\nCommand line options are listed below.\r\n\r\n#### Target Url\r\n\r\nThe url to point the application at.\r\n\r\n#### [dest]\r\n\r\nSpecifies the destination directory to build the app to, defaults to the current working directory.\r\n\r\n#### Help\r\n\r\n```\r\n-h, --help\r\n```\r\n\r\nPrints the usage informati
|