There are things I love about Sass but there are things that aggravate me.
- It's slow and makes for a cumbersome build process.
- Did I mention it's slow?!? ( Adds 3-4 seconds to the watch cycle )
I wanted to find a better way while retaining tidy stylesheets.
Insert PostCSS / PreCSS Here!
Minko's angular2-seed already uses PostCSS autoprefixer & cssnano, the simplest way to get sass-like features is to extend what already exists. As you would imagine, it's faster which is always a good thing.
What's enabled then beyond the upstream seed?
- precss - Variables, Conditionals, Loops, Mixins, Imports, Extends & Property Lookups
- cssnext - It's a long list, go check the docs as there is some pretty cool stuff coming.
Linting is handled by the existing Stylelint implementation using an extended set of rules.
Implementation instructions can be found in the wiki
A modular 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:
- Allows you to painlessly update the seed tasks of your already existing project.
- 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.
- Has autoprefixer and css-lint support.
- Basic Service Worker, which implements "Cache then network strategy".
Note that this seed project requires node v4.x.x or higher and npm 2.14.7.
Here is how to speedup the build on Windows.
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.prodDoes not rely on any global dependencies.
- Introduction
- How to start
- Table of Content
- Configuration
- How to extend?
- Running tests
- Contributing
- Advanced Seed Option
- Examples
- Directory Structure
- Contributors
- Change Log
- License
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/Visit the Wiki page of the project.
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.liveYou can learn more about Protractor Interactive Mode here
Please see the CONTRIBUTING file for guidelines.
An advanced option to this seed exists here which mirrors the latest changes here but adds core support for:
- ngrx/store RxJS powered state management, inspired by Redux
- ngrx-store-router middleware for syncing state with Angular 2 Router.
- ng2-translate for i18n
- lodash Helps reduce blocks of code down to single lines and enhances readability
- NativeScript cross platform mobile (w/ native UI) apps.
- More coming in the future...
You may use it to learn how to extend this seed for your own use cases or use the advanced seed if your project needs those features.
Forks of this project demonstrate how to extend and integrate with other libraries:
- https://github.com/justindujardin/angular2-seed - integration with ng2-material
- https://github.com/archfirst/angular2-seed-sass - integration with Sass
- https://github.com/DeviantJS/angular2-seed-material2 - integration with Angular2-Material
- https://github.com/AngularShowcase/angular2-sample-app - sample Angular 2 application
- https://github.com/AngularShowcase/ng2-bootstrap-sbadmin - ng2-bootstrap-sbadmin
- https://github.com/AngularShowcase/angular2-seed-ng2-highcharts - Simple application including a Highcharts graph.
- https://github.com/tarlepp/angular-sailsjs-boilerplate-frontend-angular2 - Example application for Sails.js integration.
- https://github.com/ludohenin/ng2-wp-blog - Angular 2 application using Wordpress JSON-API backend.
- https://github.com/AngularShowcase/angular2-seed-example-mashup - Angular 2 application demonstrating the use of Redux, D3, socket io, Google Charts, and RxJs
.
├── LICENSE
├── README.md
├── gulpfile.ts <- configuration of the gulp tasks
├── karma.conf.js <- configuration of the test runner
├── package.json <- dependencies of the project
├── protractor.conf.js <- e2e tests configuration
├── src <- source code of the application
│ ├── home
│ │ └── components
│ ├── index.html
│ ├── main.ts
│ ├── shared
│ │ └── services
│ │ ├── name-list...
│ │ └── name-list...
│ └── sw.js <- sample service worker
├── test-main.js <- testing configuration
├── tools
│ ├── README.md <- build documentation
│ ├── config
│ │ ├── project.config.ts <- configuration of the specific project
│ │ ├── seed.config....
│ │ └── seed.config.ts <- generic configuration of the seed project
│ ├── config.ts <- exported configuration (merge both seed.config and project.config, project.config overrides seed.config)
│ ├── debug.ts
│ ├── manual_typings
│ │ ├── project <- manual ambient typings for the project
│ │ │ └── sample.pac...
│ │ └── seed <- seed manual ambient typings
│ │ ├── merge-stre..
│ │ └── slash.d.ts
│ ├── tasks <- gulp tasks
│ │ ├── project <- project specific gulp tasks
│ │ │ └── sample.tas...
│ │ └── seed <- seed generic gulp tasks. They can be overriden by the project specific gulp tasks
│ ├── utils <- build utils
│ │ ├── project <- project specific gulp utils
│ │ │ └── sample_util...
│ │ ├── project.utils.ts
│ │ ├── seed <- seed specific gulp utils
│ │ │ ├── clean.ts
│ │ │ ├── code_change...
│ │ │ ├── server.ts
│ │ │ ├── tasks_tools.ts
│ │ │ ├── template_loc...
│ │ │ ├── tsproject.ts
│ │ │ └── watch.ts
│ │ └── seed.utils.ts
│ └── utils.ts
├── tsconfig.json <- configuration of the typescript project (ts-node, which runs the tasks defined in gulpfile.ts)
├── tslint.json <- tslint configuration
├── typings <- typings directory. Contains all the external typing definitions defined with typings
├── typings.json
└── appveyor.yml
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| mgechev | ludohenin | d3viant0ne | tarlepp | NathanWalker | nareshbhatia |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| jesperronn | the-ult | aboeglin | gkalpak | ryzy | pgrzeszczak |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| natarajanmca11 | njs50 | JakePartusch | jerryorta-dev | larsthorup | e-oz |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| LuxDie | TheDonDope | tsm91 | Shyam-Chen | ouq77 | evanplaice |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| hAWKdv | c-ice | markharding | domfarolino | ojacquemart | Nightapes |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| devanp92 | TuiKiken | juristr | ip512 | Yonet | inkidotcom |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| tandu | dszymczuk | dstockhammer | dwido | koodikindral | Green-Cat |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| allenhwkim | hpinsley | jeffbcross | johnjelinek | justindujardin | lihaibh |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| Brooooooklyn | brendanbenson | briantopping | mjwwit | ocombe | gdi2290 |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| typekpb | philipooo | redian | Bigous | robbatt | robertpenner |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| sclausen | tapas4java | butterfieldcons | jgolla | ultrasonicsoft | yassirh |
You can follow the Angular 2 change log here.
MIT