octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-12-23 02:28:55 +00:00
Code Issues Releases Activity
69 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%
1127084ce7
Go to file
Max Ogden 1127084ce7 add contributing
2015-05-11 17:05:22 -07:00
downloaded update name 2015-03-22 19:55:15 -07:00
.gitignore gitignore 2015-03-22 19:55:57 -07:00
.travis.yml dont download atom-shell -- use local version instead 2015-04-04 09:47:01 -07:00
cli.js cleaner error printing 2015-05-11 12:11:40 -07:00
collaborators.md update collabs 2015-05-11 12:03:44 -07:00
CONTRIBUTING.md add contributing 2015-05-11 17:05:22 -07:00
index.js return when erroring early 2015-05-11 12:10:26 -07:00
linux.js breaking change. allow building apps for other platforms 2015-05-10 13:57:42 -07:00
mac.js Ensure the out dir specified exists when building OSX app 2015-05-10 15:44:38 -07:00
package.json 4.0.2 2015-05-11 12:11:45 -07:00
readme.md update readme 2015-05-11 13:09:02 -07:00
usage.txt breaking change. allow building apps for other platforms 2015-05-10 13:57:42 -07:00
win32.js breaking change. allow building apps for other platforms 2015-05-10 13:57:42 -07:00

readme.md

electron-packager

Package your electron app in OS executables (.app, .exe, etc) via JS or CLI. Supports building Windows, Linux or Mac executables.

formerly known as atom-shell-packager

NPM

Build Status

installation

# for use in npm scripts
npm i electron-packager --save-dev

# for use from cli
npm i electron-packager -g

usage

Usage: electron-packager <sourcedir> <appname> --platform=<platform> --arch=<arch> --version=<version>
  
Required options

platform           linux, win32, darwin
arch               ia32, x64
version            see https://github.com/atom/electron/releases
                  
Example            electron-packager ./ FooBar --platform=darwin --arch=x64 --version=0.25.1

Optional options

out                the dir to put the app into at the end. defaults to current working dir
icon               the icon file to use as the icon for the app
app-bundle-id      bundle identifier to use in the app plist
app-version        version to set for the app
helper-bundle-id   bundle identifier to use in the app helper plist
ignore             do not copy files into App whose filenames regex .match this string
prune              runs `npm prune --production` on the app
asar               packages the source code within your app into an archive

This will:

  • Find or download the correct release of Electron
  • Use that version of electron to create a app in cwd named using appname for the platform you specified

You should be able to launch the app on the platform you built for. If not, check your settings and try again.

Be careful not to include node_modules you don't want into your final app. For example, do not include the node_modules/electron-packager folder or node_modules/electron-prebuilt. You can use --ignore=node_modules/electron-prebuilt to ignore of these

Building windows apps from non-windows platforms

If you run this on windows and you want to set the icon for your app using the --icon option, it requires running a thing called rcedit.exe (via this), which means you will need to install wine and have it available in your path. To do this on Mac OS you can brew install wine.

related