# angular2-boilerplate

> Angular-2 boilerplate

Latest version **2.2.0** (published 2016-09-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install angular2-boilerplate
pnpm add angular2-boilerplate
yarn add angular2-boilerplate
bun add angular2-boilerplate
```

## 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 | 2.2.0 |
| Published | 2016-09-26 |
| First published | 2016-09-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 31 |
| Known vulnerabilities | 0 (+26 in 5 direct dependencies) |
| Install scripts | yes |
| Author | Rafay Choudhury |
| Maintainers | rafay826 |
| Keywords | angular 2, angular library, angular framework, angular boilerplate, beginning angular 2, develop angular 2 |

## Links

- npm: https://www.npmjs.com/package/angular2-boilerplate
- Repository: https://bitbucket.org/rafay826/jumanjijs
- Issues: https://bitbucket.org/rafay826/jumanjijs/issues
- npm.io page: https://npm.io/package/angular2-boilerplate

## Dependencies (31)

- [gulp](https://npm.io/package/gulp.md) ^3.9.1
- [rxjs](https://npm.io/package/rxjs.md) 5.0.0-beta.12
- [jshint](https://npm.io/package/jshint.md) ^2.9.2
- [core-js](https://npm.io/package/core-js.md) ^2.4.1
- [zone.js](https://npm.io/package/zone.js.md) ^0.6.23
- [systemjs](https://npm.io/package/systemjs.md) 0.19.27
- [bootstrap](https://npm.io/package/bootstrap.md) ^3.3.6
- [gulp-sass](https://npm.io/package/gulp-sass.md) ^2.3.1
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [gulp-concat](https://npm.io/package/gulp-concat.md) ^2.6.0
- [gulp-jshint](https://npm.io/package/gulp-jshint.md) ^2.0.1
- [gulp-rename](https://npm.io/package/gulp-rename.md) ^1.2.2
- [gulp-uglify](https://npm.io/package/gulp-uglify.md) ^1.5.3
- [gulp-cssnano](https://npm.io/package/gulp-cssnano.md) ^2.1.2
- [@angular/core](https://npm.io/package/@angular/core.md) 2.0.0
- [@angular/http](https://npm.io/package/@angular/http.md) 2.0.0
- [@angular/forms](https://npm.io/package/@angular/forms.md) 2.0.0
- [gulp-clean-css](https://npm.io/package/gulp-clean-css.md) ^2.0.11
- [gulp-streamify](https://npm.io/package/gulp-streamify.md) ^1.0.2
- [@angular/common](https://npm.io/package/@angular/common.md) 2.0.0
- [@angular/router](https://npm.io/package/@angular/router.md) 3.0.0
- [gulp-sourcemaps](https://npm.io/package/gulp-sourcemaps.md) ^1.6.0
- [gulp-typescript](https://npm.io/package/gulp-typescript.md) ^2.14.1
- [@angular/upgrade](https://npm.io/package/@angular/upgrade.md) 2.0.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.3
- [@angular/compiler](https://npm.io/package/@angular/compiler.md) 2.0.0
- [gulp-autoprefixer](https://npm.io/package/gulp-autoprefixer.md) ^3.1.0
- [gulp-server-livereload](https://npm.io/package/gulp-server-livereload.md) ^1.8.1
- [@angular/platform-browser](https://npm.io/package/@angular/platform-browser.md) 2.0.0
- [angular2-in-memory-web-api](https://npm.io/package/angular2-in-memory-web-api.md) 0.0.20
- [@angular/platform-browser-dynamic](https://npm.io/package/@angular/platform-browser-dynamic.md) 2.0.0

## Recent versions

- 2.2.0 (latest) — 2016-09-26

## README

# README #

### What is this repository for? ###

Angular-2 boilperplate code with gulp building your tasks, handling the transpilation of your typescript into javascript, compiling your sass into css, and starting a local web server at http://localhost:8000. 

This library provides the basic building blocks for building Angular-2 applications transpiled from Transcript, complete with src and app scaffolding for components, directives, services, pipes, sass, javascript, and assets. 

It also comes initialized with npm commands to easily build components, directives, services, and pipes through the command line. More on that later in the readme.

* v2.2.0
    - now updated for the stable release of Angular 2.0.0!

### How do I get set up? ###

Prerequisites: node, gulp, typescript, typings.

(skip these steps if you already have the prerequisites)

If you don't have these installed, fetch 'em. 
How? Download node from the homepage at https://nodejs.org/ or install node through Homebrew if you have it. 

make sure you have node and npm installed
```
node -v
"version number"
```
```
npm -v
"version number"
```
then
```
sudo npm install -g gulp typescript typings
```

### App Installation and Getting Started ###
Install the package using npm or git:
```
sudo npm i jumanjijs
```
or
```
git clone git@bitbucket.org:rafay826/jumanjijs.git
```
Change into your project directory and run the following command line installs
```
sudo npm install
```
```
typings install
```
Run the application, starting up http://localhost:8000
```
gulp
```

### What commands come with this library? ###

All components, directives, services, and pipes that are created from the script commands get automatically placed into it's respective typescript directory in the 'src' folder.

### Creating new components: ###
```
npm run component myComponent.ts
```
all new files that get created **must** end in .ts

### Creating new directives: ###
```
npm run directive myDirective.ts
```

### Creating new services: ###
```
npm run service myService.ts
```

### Creating new pipes: ###
```
npm run pipe myPipe.ts
```

### Who do I talk to? ###

Rafay Choudhury
info@fywave.com

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