https://github.com/devwurm/angular-electron-seed

Seed project for an Angular - Electron Desktop app with the Angular-CLI
https://github.com/devwurm/angular-electron-seed

angular angular-2 angular-cli electron seed

Last synced: 4 months ago
JSON representation

Seed project for an Angular - Electron Desktop app with the Angular-CLI

• Host: GitHub
• URL: https://github.com/devwurm/angular-electron-seed
• Owner: DevWurm
• Created: 2016-12-09T15:26:02.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-25T21:15:44.000Z (over 7 years ago)
• Last Synced: 2024-10-11T08:07:23.666Z (4 months ago)
• Topics: angular, angular-2, angular-cli, electron, seed
• Language: JavaScript
• Homepage:
• Size: 85.9 KB
• Stars: 28
• Watchers: 6
• Forks: 21
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Angular - Electron seed

A biolerplate for building cross platform desktop apps with [Electron](http://electron.atom.io/), [Angular](https://angular.io/) and the [Angular-CLI](https://github.com/angular/angular-cli).

This project is based on Angular-CLI version 1.0.0.

## What you get

* Electron

* Angular 4

* Angular-CLI 1.0.0

* Bundling and transpiling with Webpack (Typescript, SASS, LESS, Stylus, etc.)

* Development server with LiveReload

* Karma, Jasmine and Protractor for testing

* Code scaffolding via Angular-CLI

* Application packaging via [electron-packager](https://github.com/electron-userland/electron-packager)

* Yarn

## Getting started

Use the seed via git:

```sh

git clone https://github.com/DevWurm/angular-electron-seed.git my-project

```

After this change into `my-project` and run

```sh

yarn install

```

## Available tools

### Build

Run `yarn run build` to build the project. The build artifacts will be stored in the `dist/` directory.

### Running the app

To run the app based on the created build results, run `yarn run run`

### Development server

Run `yarn run start` for a dev server. The app will automatically launch and reload if you change any of the source files.

###  Code scaffolding

If you have the Angular-CLI installed globally you can run `ng generate component component-name` to generate a new component. You can also use `ng generate directive/pipe/service/class/interface/enum/module`.

### Running unit tests

Run `yarn run test` to execute the unit tests via [Karma](https://karma-runner.github.io).

### Running end-to-end tests

Run `yarn run e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).

Before running the tests make sure you are serving the app in a dev server via `yarn run start`.

### Packaging releases

Run `yarn run package:win`, `yarn run package:mac`, `yarn run package:linux` or `yarn run package:all` to build binary releases for the specified plattform(s).