Skip to content

archfirst/angular2-seed-sass

Repository files navigation

Introduction

A seed project for Angular 2 apps using Sass. Derived from mgechev/angular2-seed.

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

angular2-seed-sass 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 live reload.
  • 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".
  • Sass-enabled styling.

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/archfirst/angular2-seed-sass.git cd angular2-seed-sass # 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.

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 

Change Log

You can follow the Angular 2 change log here.

License

MIT

About

Seed project for Angular 2 apps using Sass

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •