https://github.com/erha19/angular2-electron-quick-start
🎓 A angular2-electron-quick-start project.
https://github.com/erha19/angular2-electron-quick-start
angular2 angular2-electron electron webpack
Last synced: about 2 months ago
JSON representation
🎓 A angular2-electron-quick-start project.
- Host: GitHub
- URL: https://github.com/erha19/angular2-electron-quick-start
- Owner: erha19
- Created: 2017-03-03T07:33:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-28T03:10:41.000Z (over 3 years ago)
- Last Synced: 2025-10-26T11:41:12.683Z (8 months ago)
- Topics: angular2, angular2-electron, electron, webpack
- Language: JavaScript
- Size: 765 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Angular 2 electron starterkit featuring webpack
This is a starter of angular (2 and above) and electron.Its a working demo （like DHC） of [electron] with [angular] using [Webpack], [ngrx]
[](https://travis-ci.org/erha19/Angular2-electron-quick-start)
[](https://david-dm.org/erha19/Angular2-electron-quick-start)
[](https://david-dm.org/erha19/Angular2-electron-quick-start?type=dev)
## Quick start
```bash
git clone https://github.com/erha19/Angular2-electron-quick-start.git
```
Install dependencies
```bash
cd Angular2-electron-quick-start
npm install
```
Run the example
```bash
npm start
```
Hot reload on electron
```bash
npm run watch:electron
```
You can also run `npm run server:dev` to start a webpack-dev-server to debug you code on browser.
When you use Linux or OSX , you need to change the command in `package.json`,just change `set` to `export`.
## DevTools
Toggle DevTools:
* OSX: Cmd Alt I or F12
* Linux: Ctrl Shift I or F12
* Windows: Ctrl Shift I or F12
## Packaging(For test)
The app has support for packaging using 'electron-packager'
```bash
$ npm run package -- --all
```
Will run the package for OSX. You can also provide additional options to the package command such as
* --name : The package name
* --all : Will packaget the application to all the platforms
* --arch : Arches to be provided
* --icon : The icon for the app
## Generate Installer
Modify [electron-builder.yml](./electron-builder.yml) to edit package info.
For a full list of options see: https://github.com/electron-userland/electron-builder/wiki/Options.
Create a package for OSX, Windows and Linux
```
npm run pack
```
Or target a specific platform
```
npm run pack:mac
npm run pack:win
npm run pack:linux
```
## Tests
```
npm run test
```
## License
[MIT]
[Webpack]: http://webpack.github.io
[MIT]: http://markdalgleish.mit-license.org
[angular2]: http://angular.io
[electron]: http://electron.atom.io/
[ngrx]: https://github.com/ngrx/store
[material2]: https://github.com/angular/material2
[electron-packager]: https://github.com/electron-userland/electron-packager