/angular2-es6-seed

Seed project for Angular 2 ES6 apps

Primary LanguageJavaScriptMIT LicenseMIT

Introduction

MIT license Dependency Status devDependency Status

A seed project for Angular 2 ES6 apps.

It is something similar to the Angular 2 Seed but uses JSPM to manage packages and create builds.

angular2-es6-seed provides the following features:

  • Ready to go
  • A core release with just the essentials
  • A tooling release with the core and some niceties
  • A fully functional demo app
  • Development server with livereload
  • Following the best practices for your application’s structure

Table of Contents

How to Start

You must have jspm installed as global dependency:

npm install -g jspm

In order to start the seed use:

# clone the repo
git clone https://github.com/evanplaice/angular2-es6-seed.git
# change to the project
cd angular2-seed
# install the node dependencies
npm install
# install the client-side dependencies jspm
jspm install
# launch the testing server
npm start

Release Documentation

Cloning a Specific Release

To clone a specific release use:

git clone -b [branch] git@github.com:evanplaice/angular2-es6-seed.git

Directory Structure

.
├── app
│   ├── about
│   │   └── components
│   │       ├── about.html
│   │       └── about.js
│   ├── app
│   │   └── components
│   │       ├── app.css
│   │       ├── app.html
│   │       └── app.js
│   ├── home
│   │   └── components
│   │       ├── home.css
│   │       ├── home.html
│   │       └── home.js
│   ├── shared
│   │   ├── assets
│   │   │   └── img
│   │   │       └── smile.png
│   │   └── services
│   │       └── name_list.js
│   ├── main.css
│   └── main.js
├── docs
│   ├── core.md
│   └── tooling.md
├── .gitignore
├── config.js
├── CONTRIBUTING.md
├── index.html
├── LICENSE
├── package.json
└── README.md

Contributing

Please see the CONTRIBUTING file for guidelines.

Roadmap

  • add headless browser testing via karma/jasmine
  • add e2e testing via protractor
  • add npm scripts for dev and production builds

License

MIT