{"_id":"@bananajs/nxelectron","_rev":"2-dffdb76f4df36df847d30b3d0ff1f05a","name":"@bananajs/nxelectron","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.1":{"name":"@bananajs/nxelectron","version":"1.0.1","main":"src/index.js","schematics":"./collection.json","builders":"./builders.json","ng-update":{"migrations":"./migrations.json"},"peerDependencies":{"@nrwl/workspace":"*"},"dependencies":{"@angular-devkit/architect":"^0.901.7","@angular-devkit/build-webpack":"^0.901.7","@angular-devkit/core":"^9.1.7","@angular-devkit/schematics":"^9.1.7","@nrwl/jest":"^9.5.1","@nrwl/linter":"^9.5.1","@nrwl/workspace":"^9.5.1","circular-dependency-plugin":"^5.0.2","copy-webpack-plugin":"^5.1.1","electron-builder":"^22.7.0","electron-packager":"^15.0.0","fork-ts-checker-webpack-plugin":"^5.0.6","license-webpack-plugin":"^2.2.0","rimraf":"^3.0.2","source-map-support":"^0.5.19","strip-json-comments":"^3.1.1","terser-webpack-plugin":"^3.0.6","tree-kill":"^1.2.2","ts-loader":"^7.0.5","tsconfig-paths-webpack-plugin":"3.2.0","webpack":"^4.43.0","webpack-dev-server":"^3.11.0","webpack-merge":"^4.2.2","webpack-node-externals":"1.7.2"},"devDependencies":{"@types/circular-dependency-plugin":"^5.0.1","@types/copy-webpack-plugin":"^5.0.1","@types/jest":"^26.0.3","@types/node":"^14.0.14","@types/rimraf":"^3.0.0","@types/terser-webpack-plugin":"^3.0.0","@types/webpack":"^4.41.18","@types/webpack-merge":"^4.1.5","@types/webpack-node-externals":"^1.7.1","bufferutil":"^4.0.1","canvas":"^2.6.1","electron":"^9.0.5","jest":"^26.1.0","prettier":"^2.0.5","typescript":"^3.9.6","utf-8-validate":"^5.0.2"},"typings":"src/index.d.ts","description":"This library was generated with [Nx](https://nx.dev).","_id":"@bananajs/nxelectron@1.0.1","_nodeVersion":"14.8.0","_npmVersion":"6.14.7","dist":{"integrity":"sha512-KuiVoG7qREbF5FEQqEVlKW2b6YMrPd19k0/cUJ+qpKSWrOSIcwgPUETEy9akQAQq3yw84613oa1ftPvjkifdHA==","shasum":"fc969bf088a0d5db2b8a368e4f1fff7601d9c038","tarball":"https://registry.npmjs.org/@bananajs/nxelectron/-/nxelectron-1.0.1.tgz","fileCount":87,"unpackedSize":388022,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfZg/4CRA9TVsSAnZWagAAgrsP/jUWlkO4cStmsiqTsabA\nm74X7NYq+7h0pyHZiHfE/yh8GLyPWSRqrv1ivTvR6Urza72AjtTF+i7iIcnZ\nQhGefOXpoAWg6kRK/YAAIUuf8ZOxz929lRtnyJ8+Yx3c/P/873FU+jJPDn7K\nqsewhCzvAV0gqVccX6J2/ZNLTOQWvTzqBgH7s+wtCWnNeqN4DT4K3FEJJvoj\n1TmovE39y1l9cFmIMl77KQXbLzO6+72Ggh1cMR06tsPlniyU1tQVUeu00MZT\nwVVhna7BCY+Ywmra+oZtX3XIZECQ0JrlIjGwXOi17KXklGZ4pDe2Ray+wyQW\nzPPG9/F7mKCzMEXhdtfKlDyAWZQkCsIpV3cy/eB21Km5WgvfJI4BZNlBfINw\ndelrmtm/32qIrme7Eaa588Dh7fc0E+IWBsYInyXj4N57pkyn6jA/Lo15CdA3\ngrqwsmKGkaGYyb6vJSOX7HkaHx+U1p/lmbqFShvwQB1GDJTpFmOW0UO5L8wM\nRn1QIjDKuNZAvTteyA3+2a8F/D1Yg3juAfHJmE6SpjtYU5SXqsYViFo76JaX\nK2xHnc+ty/lYaEyl+JkR6ULaJdxkhhiCyZiGe4UdLFQq0Q+wwMhVBn3vKbtw\n4y/k8kNZaB4/maOL01+6isLauosE6KT51ceqT5q0Z+3HeRh81k4fuDzrRINI\nJLjb\r\n=MLvW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDzjj5+yEqfrpi/z+J+kSqMGU05K4QR5wmYgpBEmyqziwIgeUCLdPliQkXDGs64vmmF0Ie7L9FBKQEp8cw25PaybHM="}]},"maintainers":[{"name":"reidond","email":"reidond@gmail.com"}],"_npmUser":{"name":"reidond","email":"reidond@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nxelectron_1.0.1_1600524280287_0.7520506152051145"},"_hasShrinkwrap":false},"1.0.2":{"name":"@bananajs/nxelectron","version":"1.0.2","main":"src/index.js","schematics":"./collection.json","builders":"./builders.json","ng-update":{"migrations":"./migrations.json"},"peerDependencies":{"@nrwl/workspace":"*"},"dependencies":{"@angular-devkit/architect":"^0.901.7","@angular-devkit/build-webpack":"^0.901.7","@angular-devkit/core":"^9.1.7","@angular-devkit/schematics":"^9.1.7","@nrwl/jest":"^9.5.1","@nrwl/linter":"^9.5.1","@nrwl/workspace":"^9.5.1","circular-dependency-plugin":"^5.0.2","copy-webpack-plugin":"^5.1.1","electron-builder":"^22.7.0","electron-packager":"^15.0.0","fork-ts-checker-webpack-plugin":"^5.0.6","license-webpack-plugin":"^2.2.0","rimraf":"^3.0.2","source-map-support":"^0.5.19","strip-json-comments":"^3.1.1","terser-webpack-plugin":"^3.0.6","tree-kill":"^1.2.2","ts-loader":"^7.0.5","tsconfig-paths-webpack-plugin":"3.2.0","webpack":"^4.43.0","webpack-dev-server":"^3.11.0","webpack-merge":"^4.2.2","webpack-node-externals":"1.7.2"},"devDependencies":{"@types/circular-dependency-plugin":"^5.0.1","@types/copy-webpack-plugin":"^5.0.1","@types/jest":"^26.0.3","@types/node":"^14.0.14","@types/rimraf":"^3.0.0","@types/terser-webpack-plugin":"^3.0.0","@types/webpack":"^4.41.18","@types/webpack-merge":"^4.1.5","@types/webpack-node-externals":"^1.7.1","bufferutil":"^4.0.1","canvas":"^2.6.1","electron":"^9.0.5","jest":"^26.1.0","prettier":"^2.0.5","typescript":"^3.9.6","utf-8-validate":"^5.0.2"},"typings":"src/index.d.ts","description":"<p align=\"center\"><img src=\"https://raw.githubusercontent.com/bennymeg/nx-electron/master/nx-electron.png\" width=\"240\"></p>","_id":"@bananajs/nxelectron@1.0.2","_nodeVersion":"14.8.0","_npmVersion":"6.14.7","dist":{"integrity":"sha512-4SBwNB8BAn9/GrI2n+nLY3lh8d/NBmQ8jgsKl/NXyyf0wH64mYrEAQE2iD2rLjq1hHvJGUeYuFwINOpLe5AiZw==","shasum":"6c77df1d795b31008270c34b6c88a120bae069a4","tarball":"https://registry.npmjs.org/@bananajs/nxelectron/-/nxelectron-1.0.2.tgz","fileCount":87,"unpackedSize":394804,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfZlm/CRA9TVsSAnZWagAAYNQQAKIg9UwSCvsnUvOF0koc\nNAWo+PEGGSzgDfV8WiGsJA9l1d7KyDHrxXCMJ/isxey11c3VQqLh+s0urBBR\nOWfdlfsdgWjFuUI43ZBSvBPrY4BSUhLobiENm5qEoMwuE1Ri77XgeYFJO0OK\nSBGPbBPBgYo9sZdodsLRO449lUUAWaxnyS55mF/IJFlBxLUq4GCmpMwoMX8m\nayqw6N+XIe9cNkSPVdkJO/jBWS1ndimz0EbBdqqs+b8NdJpePDGXx93aW8Ik\nXjCauM05FL5+fFLxHDcP6FepGfQEzRComX78DWkhuBKRp6E6Q4ikcdKrwBGv\nM9GbUuc3Jn10XfkAYKTTsBFKP+nz58lWYlOSF/LmZh47vdGTnDQIBRpRKeMN\nAkYorC768Da7hRZrb7rRns7HFhnewXw1cGseQNa5l2UUkPXbWONGD5flSzre\nO+m+FN2nr9Z/xKAeYtfvkI9v9X6ODT3SnW6N7MoUj6zVV0cdvASR5FB3MO+I\n/vOPj/9CiOTlcOUEBqII0IkSqI9vLnFfWBPz+Rga3eMRvIkSYPRammRUNzBq\nIp4Pn8Hx16P8N88q98cpP0P7+z7ZQ8yMFyGFNB3yI64uGkoDm0u14FQioLqo\nXAN7gxQYlQKicossITFxWv2G5xL+MxIzwgTeWKPTRyJjPlkjk34XgN/FTvQD\n1AI5\r\n=+x75\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFYVlVgzH6uoOKBflw2rjoiD+yH6uCN/kjpdP/tH2fCbAiEA4IAdKJ5Ku+C244rrkMIe+vR01qmTLbhiXwjKkHyMIW8="}]},"maintainers":[{"name":"reidond","email":"reidond@gmail.com"}],"_npmUser":{"name":"reidond","email":"reidond@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nxelectron_1.0.2_1600543166771_0.2646708820769652"},"_hasShrinkwrap":false}},"time":{"created":"2020-09-19T14:04:40.052Z","1.0.1":"2020-09-19T14:04:40.428Z","modified":"2022-04-04T17:40:52.827Z","1.0.2":"2020-09-19T19:19:26.934Z"},"maintainers":[{"name":"reidond","email":"reidond@gmail.com"}],"description":"<p align=\"center\"><img src=\"https://raw.githubusercontent.com/bennymeg/nx-electron/master/nx-electron.png\" width=\"240\"></p>","readme":"<p align=\"center\"><img src=\"https://raw.githubusercontent.com/bennymeg/nx-electron/master/nx-electron.png\" width=\"240\"></p>\n\n<div align=\"center\">\n\n# Nx Electron\n\nElectron builders and schematics for Nrwl Nx platform.\n\n[![licence](https://img.shields.io/github/license/bennymeg/nx-electron.svg)](https://github.com/bennymeg/nx-electron/blob/master/LICENSE)\n[![npm version](https://img.shields.io/npm/v/nx-electron.svg)](https://www.npmjs.com/package/nx-electron)\n[![Dependencies status](https://david-dm.org/bennymeg/nx-electron/status.svg)](https://david-dm.org/bennymeg/nx-electron)\n![Downloads](https://img.shields.io/npm/dt/nx-electron)\n\n<!-- [![github version](https://img.shields.io/github/package-json/v/badges/shields.svg)](https://github.com/bennymeg/nx-electron) -->\n<!-- ![GitHub repository size in bytes](https://img.shields.io/github/languages/code-size/badges/shields.svg) -->\n\n</div>\n\n<hr></br>\n\n# Features\n\nNx Electron provides a set of power ups on [Nx](https://nx.dev) for developing cross platform desktop apps using [Electron](https://electronjs.org/).\n\n- **Schematics**: Provides schematics for developing cross platform apps in a mono repo environment.\n- **Typescript**: Uses Typescript to help reduce errors, and create more structured code.\n- **Obfuscation**: Since Electron are used on the client machines, nx-electron obfuscates you code (and only it).\n- **Minimization**: Electron apps tend to be quite large, hence we use webpack to bundle, and minimize to code.\n- **Live Update**: Provides continuos live reload for your backend code.\n- **Event Templates**: Provides templates for common events like squirrel setup events, auto update events and IPC events.\n- **Packaging**: Packages your frontend and backend webpack bundles into single electron package.\n- **Making**: Makes your frontend and backend webpack bundles into single executable. 🆕\n\n# Getting Started\n\n## Prerequisite\n\nThis module is based on Nx, you will need to [set up an Nx workspace](https://nx.dev/web/getting-started/getting-started) before you can use nx-electron.\n\n```bash\nnpx create-nx-workspace@latest\n```\n\nYou should also create a frontend project in you workspace (in any nx supported framework you like) for you electron app.\n\n## Installation\n\n```bash\nnpm install -D nx-electron\n```\n\n## Creating Electron Application\n\n```bash\nnx g nx-electron:app <electron-app-name> --frontendProject=<frontend-app-name>\n```\n\n**NOTE:** You should add a frontend project to you workspace prior to invoking this command.\n\n**NOTE:** On certain frontend platforms (such as Angular, React, etc...) it is important to change the baseHref field to \"./\", and use the hash strategy on the router in order for it to work well with electron. Further details can be found [here](https://github.com/bennymeg/nx-electron/issues/18#issuecomment-616982776).\n\n## Building Electron Application\n\n- Run `nx build <electron-app-name>` to build your application.\n\n## Serving Electron Application\n\n- Run `nx serve <electron-app-name>` to serve your application.\n\n## Packaging Electron Application\n\n- Run `nx run <electron-app-name>:package [--options]` to package your application.\n\nThe options that can be passed are described [here](https://github.com/bennymeg/nx-electron/blob/master/docs/packaging.md). **Notice:** in order to use the packaging features you will have to either [migrate](https://github.com/bennymeg/nx-electron/blob/master/docs/migration/migrating.v8.md) your project manually or create a new project (**v8.0.0 or newer**).\n\n### Configuring static packaging options\n\nIt is possible to configure all the packaging that are describes above in _`.\\apps\\<electron-app-name>\\src\\app\\options\\packager.options.json`_.\n**Notice:** the option you define at this file will override the options you pass manually via the command line or choose via the angular console.\n\n## Making Electron Application\n\n- Run `nx run <electron-app-name>:make [--options]` to make your application.\n\nThe [options](https://www.electron.build/configuration/configuration) that can be passed are described [here](https://github.com/bennymeg/nx-electron/blob/master/docs/making.md). **Notice:** in order to use the making features you will have to either [migrate](https://github.com/bennymeg/nx-electron/blob/master/docs/migration/migrating.v9.md) your project manually or create a new project (**v9.0.0 or newer**).\n\n### Configuring static making options\n\nIt is possible to configure all the making that are describes above in _`.\\apps\\<electron-app-name>\\src\\app\\options\\maker.options.json`_.\n**Notice:** the option you define at this file will override the options you pass manually via the command line or choose via the angular console.\n\n## Migrating Electron Application\n\nYou can find detailed information in the following articles:\n\n- [v8.0.0](https://github.com/bennymeg/nx-electron/blob/master/docs/migration/migrating.v8.md)\n- [v9.0.0](https://github.com/bennymeg/nx-electron/blob/master/docs/migration/migrating.v9.md)\n\n## Testing Electron Application\n\n- Run `nx test <electron-app-name>` to test your application.\n\n## Debugging Electron Application\n\n- Follow [this instructions](https://github.com/bennymeg/nx-electron/blob/master/docs/debugging.md) in order to configure the debugger your IDE.\n\n## Minimal Project Structure\n\nRegardless of what framework you chose, the resulting file tree will look like this:\n\n```treeview\n<workspace name>/\n├── apps/\n│   ├── electron-app-name/\n│   ├── frontend-app-name/\n│   └── frontend-app-name-e2e/\n├── libs/\n├── tools/\n├── nx.json\n├── package.json\n├── tsconfig.json\n└── tslint.json\n```\n\n<!-- ## Documentation ##\n- 👨🏼‍💻 [API](https://github.com/bennymeg/nx-electron/blob/master/docs/API.md),\n- 👩🏼‍🏫 [Examples](https://github.com/bennymeg/nx-electron/blob/master/docs/examples),\n- 📜 [Change log](https://github.com/bennymeg/nx-electron/blob/master/docs/CHANGELOG.md),\n- 🖋 [Licence](https://github.com/bennymeg/nx-electron/blob/master/LICENSE) -->\n\n## Support\n\nIf you're having any problem, please [raise an issue](https://github.com/bennymeg/nx-electron/issues/new) on GitHub and we'll be happy to help.\n\n## Contribute\n\nBefore submitting a pull request, please make sure that you include tests and lints runs without any warnings.\n\n- 👾 [Issue Tracker](https://github.com/bennymeg/nx-electron/issues),\n- 📦 [Source Code](https://github.com/bennymeg/nx-electron/)\n\n## Versioning\n\nThis repository follows the semantic versioning rules while adhering to Nx and Angular version scheme.\n\n## Attribution\n\nThis project is highly inspired by (and dependent on) Nrwl [Nx](https://nx.dev) platform.\nUnder the hood, we use [Electron Packager](https://github.com/electron/electron-packager) to package the electron application and [Electron Builder](https://github.com/electron-userland/electron-builder) to make executables.\n\n</br><hr>\n**Author:** Benny Megidish.\n","readmeFilename":"README.md"}