https://github.com/shibbir/generator-angular-project

Scaffold out a front-end project with angular and typescript
https://github.com/shibbir/generator-angular-project

angular protractor typescript webpack yeoman

Last synced: 2 months ago
JSON representation

Scaffold out a front-end project with angular and typescript

• Host: GitHub
• URL: https://github.com/shibbir/generator-angular-project
• Owner: shibbir
• License: mit
• Created: 2017-08-19T12:46:21.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-01T06:03:59.000Z (over 7 years ago)
• Last Synced: 2025-03-12T15:17:42.094Z (3 months ago)
• Topics: angular, protractor, typescript, webpack, yeoman
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/generator-angular-project
• Size: 151 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Angular-Project generator

> Yeoman generator for scaffold out a front-end project with Angular and TypeScript

[![NPM](https://nodei.co/npm/generator-angular-project.png?compact=true)](https://nodei.co/npm/generator-angular-project/)

[![Build Status](https://travis-ci.org/shibbir/generator-angular-project.svg?branch=master)](https://travis-ci.org/shibbir/generator-angular-project)

[![CircleCI](https://circleci.com/gh/shibbir/generator-angular-project.svg?style=shield)](https://circleci.com/gh/shibbir/generator-angular-project)

[![Dependencies Status](https://david-dm.org/shibbir/generator-angular-project/status.svg)](https://david-dm.org/shibbir/generator-angular-project)

[![Coverage Status](https://coveralls.io/repos/github/shibbir/generator-angular-project/badge.svg?branch=master)](https://coveralls.io/github/shibbir/generator-angular-project?branch=master)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

## Installation

You need to have latest version of [Node.js](https://nodejs.org/en/) installed on your machine before running the followings:

```bash

npm install -g yo generator-angular-project

```

Make a new directory, and cd into it:

```bash

mkdir my-new-project && cd $_

```

Run `yo angular-project`, optionally passing an app name:

```bash

yo angular-project [app-name]

```

That'll generate a project including:

- Configured `package.json` file

- [Gulp](http://gulpjs.com/) task runner integration

- Plain CSS, [Bootstrap](http://getbootstrap.com/) or [Foundation](http://foundation.zurb.com/) integration

- Either [Webpack](https://webpack.github.io/) or [SystemJS](https://github.com/systemjs/systemjs) integration

- [Karma](https://karma-runner.github.io/) unit test runner

- End-to-end tests with [Protractor](http://www.protractortest.org/)

- [Istanbul](https://gotwarlost.github.io/istanbul/) code coverage

- [TSLint](https://palantir.github.io/tslint/) linting for the TypeScript language

- [License](https://spdx.org/licenses/)

## Contribute

When submitting an issue, please make sure that Yeoman is up-to-date, and also provide the command or commands that cause the issue.

When submitting a PR, make sure that the commit messages match the [AngularJS conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).

When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

When submitting a new feature, add tests that cover the feature.

## License

The MIT License