/angular-electron

Quick start your desktop app using angular and electron.

Primary LanguageTypeScriptMIT LicenseMIT

angular-electron-logo

Build Status Dependencies Status Coverage Status Known Vulnerabilities

Angular Electron

Don't think too much about configuration, just focus on code.

Before You Begin

If you are new to the angular world, electron world or both it's recommended to take a look at the documentation first.

Prerequisites

Install @angular/cli globally.

$ yarn add global @angular/cli
# or
$ npm i -g @angular/cli

Install electron globally.

$ yarn add global electron
# or
$ npm i -g electron

How to Use?

Get clone from the repo.

$ git clone https://github.com/AhmedMKamal/angular-electron.git

Redirect to the repo folder.

$ cd angular-electron

Install the dependencies.

$ yarn install
# or
$ npm install

Build the app.

$ yarn build
# or
$ npm run build

And see it in action.

$ yarn start
# or
$ npm start

Running the tests

Simply run.

$ yarn test
# or
$ npm run test

And e2e.

$ yarn ng:e2e
# or
$ npm run ng:e2e

The build and test processes have lint hook by default and will fail if the linting process failed.

Deployment

I don't want to stuck with specific packing tool, so it's up to you to choose one of the most used tools listed below.

Credits

Thanks ThorstenHans for the package ngx-electron ❤️

License

The MIT License