generator-angular2
Version:
Angular2 Yeoman Generator
67 lines (41 loc) • 1.82 kB
Markdown
# Generator Angular2
[](https://travis-ci.org/swirlycheetah/generator-angular2) [](https://gitter.im/swirlycheetah/generator-angular2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
A [Yeoman](http://yeoman.io) Generator to aid in bootstrapping an Angular2 application using the very latest Angular2 alpha release.
### Getting Started
Install both [Yeoman](http://yeoman.io) and this generator globally.
```bash
npm install -g yo generator-angular2
```
In your desired project folder run the generator.
```bash
yo angular2
```
You'll be prompted to start the server once the generator has finished.
You'll then be able to access the application at `http://localhost:8000`. Serving the application can be configured in the `gulpfile.js` using [gulp-webserver](https://www.npmjs.com/package/gulp-webserver) options.
### Generated Structure
The structure generated is;
```
- src
- index.js
- index.html
- {generated-file-name}.js
- {generated-file-name}.html
- .editorconfig
- .gitignore
- gulpfile.js
- package.json
- readme.md
```
### Developing
All contributions are more than welcome, no matter how large or small.
Clone the repository and `cd` into it
`git clone git@github.com:swirlycheetah/generator-angular2.git && cd generator-angular2`
Install the project dependencies
`npm install`
Link the package to use the version you're working on
`npm link`
Run the tests to ensure no failures
`npm test`
Submit a pull request with your changes
### License
Released under the MIT license: [opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)