Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thescientist13/angular2-typescript-poc

An Angular2 / TypeScript / SystemJS / Gulp POC
https://github.com/thescientist13/angular2-typescript-poc

Last synced: 6 days ago
JSON representation

An Angular2 / TypeScript / SystemJS / Gulp POC

Awesome Lists containing this project

README

        

## Overview
This project is intended to be a POC for Angular2 and TypeScript built on top of some new and current JavaScript
build tools. It is built off of the Angular2 5 minute quick start [tutorial][] and the [Tour of Heroes][] tutorial.
Specific objectives include:

- Use [Angular2][]
- Use [TypeScript][]
- Use a module loading system
- One package manager (eg. No [Bower][] _and_ [NPM][])
- Emphasis on [ES6][] compatibility
- Interop with [Gulp][]

Tools under consideration

- [JSPM][] / [SystemJS][] (polyfill for [ES6 modules][])
- [Browserify][] (not monolithic, uses [CommonJS][] `require('some-module')` syntax
- [Webpack][] (complete asset bundler, but emphasizes configuration files, like Grunt)
- ES6 classes, module loading

A good article on all the current module loading libraries can be found [here][]

[tutorial]: https://angular.io/docs/ts/latest/quickstart.html
[Tour of Heroes][]: https://angular.io/docs/ts/latest/tutorial/
[Angular2]: https://angular.io/
[TypeScript]: http://www.typescriptlang.org/
[Bower]: http://bower.io/
[NPM]: https://www.npmjs.com/
[ES6]: http://es6-features.org/#Constants
[Gulp]: http://gulpjs.com/
[JSPM]: http://jspm.io/
[SystemJS]: https://github.com/systemjs/systemjs
[ES6 Modules]: http://www.2ality.com/2014/09/es6-modules-final.html
[Browserify]: http://browserify.org/
[CommonJS]: http://requirejs.org/docs/commonjs.html
[Webpack]: http://webpack.github.io/

[here]: http://survivejs.com/webpack_react/webpack_compared/

## Setup
1. Install NodeJS (comes with NPM)
2. Install gulp globally `npm install -g gulp`
3. Install dependencies `npm install`
4. Install typings `node_modules/typings/dist/bin/typings.js install`

## Running the POC
To view this POC locally, run `gulp build:develop`

**Note: some of the styles have been commented out in favor of best practices**

## Continuos Integration
All PRs to this repo will be run against Jenkins. The build script exectuted is in `bin/build.sh`