# generator-ng2-pro

> A yeoman generator to scaffold an Angular2 application

Latest version **1.1.3** (published 2017-07-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-ng2-pro
pnpm add generator-ng2-pro
yarn add generator-ng2-pro
bun add generator-ng2-pro
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2017-07-10 |
| First published | 2017-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Erandi |
| Maintainers | erandipraboda, jayathuam |
| Keywords | webpack, yarn, karma, Jasmine, TSLint, SASS Lint, Istanbul, yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-ng2-pro
- Repository: https://github.com/ErandiPraboda/generator-ng2-pro
- Homepage: https://github.com/ErandiPraboda/generator-ng2-pro#readme
- Issues: https://github.com/ErandiPraboda/generator-ng2-pro/issues
- npm.io page: https://npm.io/package/generator-ng2-pro

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) 1.1.3
- [yosay](https://npm.io/package/yosay.md) 1.2.1
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) 1.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.1.3 (latest) — 2017-07-10
- 1.1.2 — 2017-07-10
- 1.1.1 — 2017-07-01
- 1.1.0 — 2017-07-01
- 1.0.9 — 2017-07-01
- 1.0.8 — 2017-06-30
- 1.0.7 — 2017-06-30
- 1.0.6 — 2017-02-27
- 1.0.5 — 2017-02-20
- 1.0.4 — 2017-02-16
- 1.0.3 — 2017-02-16
- 1.0.2 — 2017-02-16
- 1.0.1 — 2017-02-16
- 1.0.0 — 2017-02-16

## README

A yeoman generator to scaffold an Angular2 application

[![Build Status](https://travis-ci.org/Erandi1234/generator-ng2-pro.svg?branch=master)](https://travis-ci.org/Erandi1234/generator-ng2-pro)
[![DUB](https://img.shields.io/dub/l/vibe-d.svg)](https://opensource.org/licenses/MIT)  [![npm](https://img.shields.io/npm/dm/localeval.svg)]() [![npm](https://img.shields.io/npm/v/npm.svg)]()

## Installation

First, install [Yeoman](http://yeoman.io) and generator-ng2-pro using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/) ).

* Installing yarn 
```bash
npm install -g yarn 
npm install -g yo
npm install -g generator-ng2-pro
```

Then generate your new project:

```bash
yo ng2-pro
```
steps

* Run yarn start from a terminal
* Navigate to http://localhost:8080/ The app will automatically reload if you change any of the source files 

## Features

![img](https://raw.githubusercontent.com/ErandiPraboda/generator-ng2-pro/master/assets/karma.png)
![img](https://raw.githubusercontent.com/ErandiPraboda/generator-ng2-pro/master/assets/istanbul.png)
![img](https://raw.githubusercontent.com/ErandiPraboda/generator-ng2-pro/master/assets/sass.png)
![img](https://raw.githubusercontent.com/ErandiPraboda/generator-ng2-pro/master/assets/ts_lint.png)
![img](https://raw.githubusercontent.com/ErandiPraboda/generator-ng2-pro/master/assets/typedoc.png)
![img](https://raw.githubusercontent.com/ErandiPraboda/generator-ng2-pro/master/assets/webpack.png)
![img](https://raw.githubusercontent.com/ErandiPraboda/generator-ng2-pro/master/assets/yarn.jpg)

## Scaffold Complete Directory Layout
```bash
├── /config/                   
    └── /helpers.js
    └── /karma-test-shim.js
    └── /webpack.common.js
    └── /webpack.dev.js
    └── /webpack.test.js
├── /public/                    
    ├── /css
    ├── /images
├── /src/                       
    ├── /app
         └── /app.component.html
         └── /app.component.scss
         └── /app.component.spec.ts
         └── /app.component.ts
         └── /app.module.ts
    ├── /index.html
    └── main.ts
    └── polyfills.ts
    └── vendor.ts
├── /node_modules/             
├── .gitignore                                    
├── .travis.yml                                     
├── karma.conf.js              
├── Readme.md                
├── package.json                
├── typedoc.json                  
├── tsconfig.json              
├── tslint.json               
└── typings.json                
└── webpack.conf.js 
```
## Usage

That'll generate a project with all the common tools setup. This includes:
Filled package.json file 
* [Webpack](https://webpack.js.org/) task runner
* [Jasmine](https://jasmine.github.io/) unit testing
* [Karma](https://karma-runner.github.io/1.0/index.html) test runner
* [TSLint](https://palantir.github.io/tslint/) and [SASS Lint](https://www.npmjs.com/package/sass-lint) linting and code style checking
* [Istanbul](https://webpack.js.org/) code coverage
* [Travis CI](https://travis-ci.org/) continuous integration

Generating Component, Directives, Pipes and Services
```bash
You can use yo ng2-pro command to generate Angular Componenet, Directives, Pipes and Services

Scaffold               Usage
Component              yo ng2-pro:component --name [component-name]
Directive              yo ng2-pro:directive --name [directive-name]
Pipe                   yo ng2-pro:pipe --name [pipe-name]
Service                yo ng2-pro:service --name [service-name]
Interface              yo ng2-pro:interface --name [interface-name]
```
## Testing
```bash
yarn test
```

## Tslint
Uses the sass-lint npm module to check ts files. you can use this linter by runing following command
```bash
yarn tslint
```

## sass-lint
Uses the sass-lint npm module to check scss and sass files. you can use this linter by runing following command
```bash
yarn sass-lint
```
## Getting To Know Yeoman

 * Yeoman has a heart of gold.
 * Yeoman is a person with feelings and opinions, but is very easy to work with.
 * Yeoman can be too opinionated at times but is easily convinced not to be.
 * Feel free to [learn more about Yeoman](http://yeoman.io/).

## License

MIT © [Erandi](erandipraboda@gmail.com)

---
_Source: https://npm.io/package/generator-ng2-pro · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._