https://github.com/mackignacio/electron-angular-quickstart
Fastest way to start and develop electron with angular for desktop applications. Bootstrapping includes hot reload, electron services, routing, scss support and typescript for electron.
https://github.com/mackignacio/electron-angular-quickstart
angular angular-cli angular-material angular2 angular4 angular5 angular6 builder desktop-app desktop-application electron electron-app electron-application electronjs hotreload scss typescript
Last synced: 5 days ago
JSON representation
Fastest way to start and develop electron with angular for desktop applications. Bootstrapping includes hot reload, electron services, routing, scss support and typescript for electron.
- Host: GitHub
- URL: https://github.com/mackignacio/electron-angular-quickstart
- Owner: mackignacio
- License: mit
- Created: 2018-07-26T01:31:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-13T06:39:02.000Z (about 6 years ago)
- Last Synced: 2025-04-18T00:57:03.654Z (11 days ago)
- Topics: angular, angular-cli, angular-material, angular2, angular4, angular5, angular6, builder, desktop-app, desktop-application, electron, electron-app, electron-application, electronjs, hotreload, scss, typescript
- Language: HTML
- Homepage:
- Size: 294 KB
- Stars: 9
- Watchers: 4
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Electron Angular Quickstart
[](https://angular.io/)
[](https://electron.atom.io/)
This is a project for creating your first electron desktop app. You can use this to easily setup your basic electron + angular project files for your development.
Currently runs with:
- [Angular CLI](https://github.com/angular/angular-cli) v7.1.3
- [Angular Material](https://github.com/angular/angular-cli) v7.1.1
- [Electron](https://github.com/electron/electron/tree/v2.0.5) v3.0.8
- [Electron Builder](https://github.com/electron-userland/electron-builder/tree/v20.25.0) v20.25.0
- [Electron Reload](https://github.com/yan-foto/electron-reload) v1.2.5
- [TypeScript](https://github.com/Microsoft/TypeScript) v3.1.6
With this sample, you can :
- Run your app in a local development environment with Electron & Hot reload
- Run your app in a production environment
- Package your app into an executable file for Linux, Windows & Mac
## Getting Started
Clone this repository locally :
```bash or cmd
git clone https://github.com/Mackignacio/electron-angular-quickstart.git
```
Install dependencies with npm :
```bash or cmd
npm install
```
Install rimraf globally with npm :
```bash or cmd
npm install rimraf -g
```
Install Angular with npm :
- If you have no Angular installed in your machine follow this command.
```bash or cmd
npm install -g @angular/cli@latest
```
```bash or cmd
ng update @angular/cli && ng update @angular/core && ng update @angular/material
```
- If you had installed a previous version of `Angular CLI`.
Please follow [Angular Update Guide](https://update.angular.io/).
## Development
- **in a terminal window** -> npm start
Now you can experience a fast way of developing desktop apps using `Angular` + `Electron` with hot swaping and hot reloading.
This package includes a basic boiler plate example code for an `Electron` App using `Angular`. With this basic example you can develop your app using `Angular` and package it with `Electron` window as a desktop App. The `Electron` codes are managed by `main.ts` file on your root directory.
Developing with this package make it easy because its enable you to change your code and its automatically updates your `Electron` app. This package eliminates the repetition of closing and running again of your `Electron` app on your terminal. You can change codes and see it update to your apps in a couple of seconds.
## Versions
### Released Versions
- Latest Version : [v1.2.2](https://github.com/Mackignacio/electron-angular-quickstart/tree/v1.2.2)
- Stable Version : [v1.2.0](https://github.com/Mackignacio/electron-angular-quickstart/tree/v1.2.0)
### Other Stable Versions
- [v1.1.0](https://github.com/Mackignacio/electron-angular-quickstart/tree/v1.1.0)
- [v1.0.0](https://github.com/Mackignacio/electron-angular-quickstart/tree/v1.0.0)