angular2-seed-jade editorconfig travis-ci circleci karma npm

Fork of angular2-seed adding SASS, Jade and Bootstrap.

Introduction

Angular 2 Style Guide Build Status Join the chat at https://gitter.im/mgechev/angular2-seed MIT license Dependency Status devDependency Status

A seed project for Angular 2 apps.

It is something similar to the Angular Quick Start but does the entire build with gulp.

angular2-seed provides the following features:

  • Ready to go, statically typed build system using gulp for working with TypeScript.
  • Production and development builds.
  • Sample unit tests with Jasmine and Karma including code coverage via istanbul.
  • End-to-end tests with Protractor.
  • Development server with Livereload.
  • Following the best practices for your application’s structure.
  • Manager of your type definitions using typings.
  • Basic Service Worker, which implements “Cache then network strategy”.

Fork notes

This fork adds SASS and Jade preprocessors support, and includes the Twitter Bootstrap module.

Soon to include: the Firebase module.

How to start

Note that this seed project requires node v4.x.x or higher and npm 2.14.7.

You must have ts-node installed as global. If you don’t, use:

npm install -g ts-node

In order to start the seed use:

git clone --depth 1 https://github.com/mgechev/angular2-seed.git
cd angular2-seed
# install the project's dependencies
npm install
# watches your files and uses livereload by default
npm start
# api document for the app
npm run docs

# dev build
npm run build.dev
# prod build
npm run build.prod

Does not rely on any global dependencies.

Table of Content

Configuration

Default application server configuration

var PORT             = 5555;
var LIVE_RELOAD_PORT = 4002;
var DOCS_PORT        = 4003;
var APP_BASE         = '/';

Configure at runtime

npm start -- --port 8080 --reload-port 4000 --base /my-app/

How to extend?

Visit the Wiki page of the project.

Running tests

npm test

# Debug - In two different shell windows
npm run build.test.watch      # 1st window
npm run karma.start           # 2nd window

# code coverage (istanbul)
# auto-generated at the end of `npm test`
# view coverage report:
npm run serve.coverage

# e2e (aka. end-to-end, integration) - In three different shell windows
# Make sure you don't have a global instance of Protractor

# npm run webdriver-update <- You will need to run this the first time
npm run webdriver-start
npm run serve.e2e
npm run e2e

# e2e live mode - Protractor interactive mode
# Instead of last command above, you can use:
npm run e2e.live

You can learn more about Protractor Interactive Mode here

Contributing

Please see the CONTRIBUTING file for guidelines.

Examples

Forks of this project demonstrate how to extend and integrate with other libraries:

Directory Structure

.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── src
│   ├── about
│   │   └── components
│   │       ├── about.e2e.ts
│   │       ├── about.html
│   │       ├── about.ts
│   │       └── about.spec.ts
│   ├── app
│   │   └── components
│   │       ├── app.css
│   │       ├── app.e2e.ts
│   │       ├── app.html
│   │       ├── app.ts
│   │       └── app.spec.ts
│   ├── assets
│   │   ├── img
│   │   │   └── smile.png
│   │   └── main.css
│   ├── home
│   │   └── components
│   │       ├── home.css
│   │       ├── home.html
│   │       ├── home.ts
│   │       ├── home.e2e.ts
│   │       └── home.spec.ts
│   ├── shared
│   │   └── services
│   │       ├── name_list.ts
│   │       └── name_list.spec.ts
│   ├── hot_loader_main.ts
│   ├── main.ts
│   └── index.html
├── dist
├── tools
│   ├── manual_typings
│   ├── tasks
│   ├── utils
│   ├── config.ts
│   └── utils.ts
├── appveyor.yml
├── gulpfile.ts
├── karma.conf.js
├── package.json
├── protractor.conf.js
├── test-main.js
├── tsconfig.json
├── tslint.json
└── typings.json

Contributors

mgechev ludohenin tarlepp NathanWalker nareshbhatia jesperronn
mgechev ludohenin tarlepp NathanWalker nareshbhatia jesperronn
d3viant0ne aboeglin ryzy natarajanmca11 JakePartusch larsthorup
d3viant0ne aboeglin ryzy natarajanmca11 JakePartusch larsthorup
ouq77 jerryorta-dev devanp92 evanplaice LuxDie c-ice
ouq77 jerryorta-dev devanp92 evanplaice LuxDie c-ice
ojacquemart TuiKiken juristr dstockhammer briantopping dszymczuk
ojacquemart TuiKiken juristr dstockhammer briantopping dszymczuk
brendanbenson dwido koodikindral jeffbcross johnjelinek justindujardin
brendanbenson dwido koodikindral jeffbcross johnjelinek justindujardin
philipooo lihaibh tandu inkidotcom markharding mjwwit
philipooo lihaibh tandu inkidotcom markharding mjwwit
ocombe gdi2290 typekpb Brooooooklyn redian Bigous
ocombe gdi2290 typekpb Brooooooklyn redian Bigous
robertpenner sclausen tapas4java butterfieldcons jgolla ultrasonicsoft
robertpenner sclausen tapas4java butterfieldcons jgolla ultrasonicsoft

Change Log

You can follow the Angular 2 change log here.

License

MIT

Related Repositories

angular2-seed-jade

angular2-seed-jade

Fork of angular2-seed adding SASS, Jade and Bootstrap. ...


Top Contributors

mgechev ludohenin tarlepp NathanWalker d3viant0ne nareshbhatia jesperronn LuxDie aboeglin ryzy pgrzeszczak natarajanmca11 JakePartusch jerryorta-dev larsthorup ouq77 devanp92 evanplaice c-ice markharding ojacquemart TuiKiken juristr allenhwkim brendanbenson briantopping dszymczuk dstockhammer dwido koodikindral

Releases

-   2.0.0-beta.0 zip tar
-   2.0.0-alpha.55 zip tar
-   2.0.0-alpha.54 zip tar
-   2.0.0-alpha.53 zip tar
-   2.0.0-alpha.52 zip tar
-   2.0.0-alpha.51 zip tar
-   2.0.0-alpha.50 zip tar
-   2.0.0-alpha.49 zip tar
-   2.0.0-alpha.48 zip tar
-   2.0.0-alpha.47 zip tar
-   2.0.0-alpha.46 zip tar
-   2.0.0-alpha.45 zip tar
-   2.0.0-alpha.44 zip tar
-   2.0.0-alpha.42 zip tar
-   2.0.0-alpha.41 zip tar
-   2.0.0-alpha.40 zip tar
-   2.0.0-alpha.39 zip tar
-   2.0.0-alpha.38 zip tar
-   2.0.0-alpha.37 zip tar
-   2.0.0-alpha.36 zip tar
-   2.0.0-alpha.35 zip tar
-   2.0.0-alpha.34 zip tar
-   2.0.0-alpha.33 zip tar
-   2.0.0-alpha.32 zip tar
-   2.0.0-alpha.31 zip tar
-   2.0.0-alpha.30 zip tar
-   2.0.0-alpha.29 zip tar
-   2.0.0-alpha.28 zip tar
-   2.0.0-alpha.27 zip tar
-   2.0.0-alpha.26 zip tar