Skip to content

jimthedev/angular2-seed

 
 

Repository files navigation

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.

Note: Angular 2.0 is not production ready yet! This seed project is perfect for playing around with the latest versions but do not start new projects with it since a lot of new changes are going to be introduced until the framework is officially released.

How to start

Note that this seed project requires node v0.12.x or higher and npm 3.x.x.

git clone https://github.com/mgechev/angular2-seed.git
cd angular2-seed
npm install   # clean npm cache & delete node_modules folder if you get an error
npm start     # start with --env dev

Does not rely on any global dependencies.

Directory Structure

.
├── app
│   ├── components
│   │   ├── about
│   │   │   ├── about.html
│   │   │   ├── about.ts
│   │   │   └── about_spec.ts
│   │   └── home
│   │       ├── home.css
│   │       ├── home.html
│   │       ├── home.ts
│   │       └── home_spec.ts
│   ├── services
│   │   ├── name_list.ts
│   │   └── name_list_spec.ts
│   ├── typings
│   ├── app.css
│   ├── app.html
│   ├── app.ts
│   ├── index.html
│   └── init.ts
├── dist
│   ├── dev
│   └── prod
├── tools
│   ├── tasks
│   ├── utils.js
│   └── workflow.config.js
├── tsd_typings
├── gulpfile.js
├── karma.conf.js
├── package.json
├── test-main.js
├── tsconfig.json
└── tsd.json

Configuration

Default application server configuration

var PORT             = 5555;
var LIVE_RELOAD_PORT = 4002;
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

Contributors

mgechev ludohenin NathanWalker tarlepp aboeglin jerryorta-dev
mgechev ludohenin NathanWalker tarlepp aboeglin jerryorta-dev
TuiKiken ryzy ultrasonicsoft mjwwit natarajanmca11 philipooo
TuiKiken ryzy ultrasonicsoft mjwwit natarajanmca11 philipooo
redian robertpenner jgolla dstockhammer
redian robertpenner jgolla dstockhammer

Change Log

You can follow the Angular 2 change log here.

License

MIT

About

Seed project for Angular 2 apps

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 54.6%
  • JavaScript 31.6%
  • HTML 9.5%
  • CSS 4.3%