ngx-yeoman-app

A desktop app that scaffolds projects using Yeoman. Based on yeoman-app.

Built with angular-electron which is written in Angular 6 and provides many great features such as hot-reloading duing development. Electron main process written in Typescript.

This project is based on yeoman-app which has been unmaintained since October 2016. I saw a need for an application that would leverage many of the features included in this project, so I decided to make a first pass effort at re-writing this application and bringing it up to speed with the present.

Features

• Main Process Written in Typescript

  • Reap all the benefits of writing in typescript in the main electron process that interfaces with the yeoman environment
  • Eliminates need for previous dependencies such as babel-plugin-transform-es2015-modules-commonjs, babel-preset-es2015, babel-preset-react, babel-preset-stage-0, babel-register, and more.

• Main process written in Angular 6

  • Using angular-electron developing and building an electron desktop app has never been easier
  • Leverages ngrx for easy state control using rxjs observables

Usage

If you just want to run the desktop app, you can download and run the portable executables:

• Windows
• MacOs

If you want to use this as a boilerplate to start your own angular project that interacts with the yeoman environment, check out the sections below on installation and development.

Installation

To install the application for use on your local machine without downloading & running the executable, follow these steps

$ git clone https://github.com/alexbatis/ngx-yeoman-app
$ cd ngx-yeoman-app
$ npm install

Execution & Development

To run the app, simply run

$ npm start

This will start the app with hot-reloading on all the renderer (angular) code. This is the preferred development command.

Build

To build the app into an executable, run the following command

$ npm run electron:<platform>

where platform is either windows, mac, or linux based on which OS you're running.

Contributing

If you're interested in contributing, please reach out. This app is still in its infancy, but if there is the demand I'd be willing to allocate more time to it. All contributions and feedback are welcomed.

References

• yeoman
• yeoman-app
• angular
• electron
• angular-electron

License

MIT © Alex Batis