angular2-seed 0 editorconfig travis-ci circleci karma npm

Seed project for Angular 2 apps with statically typed build

Introduction

Join the chat at https://gitter.im/mgechev/angular2-seed Dependency Status devDependency Status Build Status

A seed project for Angular 2 apps.

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

How to start

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

git clone https://github.com/mgechev/angular2-seed.git
cd angular2-seed
npm install       # or `npm run reinstall` if you get an error
npm start         # start with --env dev
npm run docs      # api document for app

Does not rely on any global dependencies.

Directory Structure

.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── app
│   ├── assets
│   │   ├── img
│   │   │   └── smile.png
│   │   └── main.css
│   ├── bootstrap.ts
│   ├── components
│   │   ├── about
│   │   │   ├── about.html
│   │   │   ├── about.ts
│   │   │   └── about_spec.ts
│   │   ├── app
│   │   │   ├── app.css
│   │   │   ├── app.html
│   │   │   ├── app.ts
│   │   │   └── app_spec.ts
│   │   └── home
│   │       ├── home.css
│   │       ├── home.html
│   │       ├── home.ts
│   │       └── home_spec.ts
│   ├── index.html
│   └── services
│       ├── name_list.ts
│       └── name_list_spec.ts
├── appveyor.yml
├── circle.yml
├── dist
│   └── dev
│       ├── assets
│       │   └── img
│       │       └── smile.png
│       ├── bootstrap.js
│       ├── components
│       │   ├── about
│       │   │   └── about.js
│       │   ├── app
│       │   │   └── app.js
│       │   └── home
│       │       └── home.js
│       ├── index.html
│       └── services
│           └── name_list.js
├── gulpfile.ts
├── karma.conf.js
├── package.json
├── test
│   ├── components
│   │   ├── about
│   │   │   ├── about.js
│   │   │   └── about_spec.js
│   │   ├── app
│   │   │   ├── app.js
│   │   │   └── app_spec.js
│   │   └── home
│   │       ├── home.js
│   │       └── home_spec.js
│   └── services
│       ├── name_list.js
│       └── name_list_spec.js
├── test-main.js
├── tools
│   ├── config.ts
│   ├── tasks
│   │   ├── build.bundles.ts
│   │   ├── build.deps.ts
│   │   ├── build.docs.ts
│   │   ├── build.html_css.prod.ts
│   │   ├── build.img.dev.ts
│   │   ├── build.index.ts
│   │   ├── build.js.dev.ts
│   │   ├── build.js.prod.ts
│   │   ├── build.sass.dev.ts
│   │   ├── build.test.ts
│   │   ├── check.versions.ts
│   │   ├── clean.ts
│   │   ├── karma.start.ts
│   │   ├── npm.ts
│   │   ├── serve.docs.ts
│   │   ├── server.start.ts
│   │   ├── tsd.ts
│   │   ├── tslint.ts
│   │   ├── watch.dev.ts
│   │   ├── watch.serve.ts
│   │   └── watch.test.ts
│   ├── typings
│   ├── utils
│   │   ├── server.ts
│   │   ├── tasks-tools.ts
│   │   ├── template-injectables.ts
│   │   └── template-locals.ts
│   └── utils.ts
├── tsconfig.json
├── tsd.json
└── tslint.json

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/

Now to extend?

If you want to use your custom libraries:

npm install my-library --save
vim tools/config.js

Add reference to the installed library in PATH.src.jslib (or whatever you like).

Running test

npm test

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

Contributing

Please see the CONTRIBUTING file for guidelines.

Contributors

mgechev ludohenin tarlepp NathanWalker jesperronn aboeglin
mgechev ludohenin tarlepp NathanWalker jesperronn aboeglin
ryzy natarajanmca11 jerryorta-dev JakePartusch larsthorup TuiKiken
ryzy natarajanmca11 jerryorta-dev JakePartusch larsthorup TuiKiken
johnjelinek evanplaice ultrasonicsoft Brooooooklyn tandu markharding
johnjelinek evanplaice ultrasonicsoft Brooooooklyn tandu markharding
mjwwit ocombe gdi2290 philipooo redian robertpenner
mjwwit ocombe gdi2290 philipooo redian robertpenner
sclausen butterfieldcons jgolla dstockhammer
sclausen butterfieldcons jgolla dstockhammer

Change Log

You can follow the Angular 2 change log here.

License

MIT

Related Repositories

angular2-seed

angular2-seed

:seedling: A simple Angular 2 seed featuring Angular 2 and Webpack 2 by @AngularClass ...

angular2-react-native-seed

angular2-react-native-seed

A seed project to create a native mobile application with Angular 2 and React Native ...

angular2-login-seed

angular2-login-seed

Seed app featuring Angular2, Node.js + Express, and OAuth login support via Passport ...

angular2-seed

angular2-seed

Seed project to run angular2 out of the box, integrated with wepack and babel ...


Top Contributors

mgechev ludohenin tarlepp NathanWalker jesperronn aboeglin ryzy natarajanmca11 jerryorta-dev JakePartusch larsthorup TuiKiken johnjelinek dstockhammer evanplaice briantopping Brooooooklyn tandu markharding mjwwit ocombe gdi2290 philipooo redian robertpenner sclausen gitter-badger butterfieldcons jgolla ultrasonicsoft

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