Angular Library Seed

Quick Start

$ cd path/to/folder

$ npm install

# start the demo server of the seed library
$ npm start

go to http://localhost:8181 in your browser.

Now get to work making your library.

Overview

A simple straight-forward seed for creating Angular Libraries.

• Quick start with one sample of each already created (with tests)
• Uses Webpack to demo your library.
• Testing Angular code with Jasmine and Karma.
• End-to-end Angular code using Protractor.
• Error reported with TSLint.
• Documentation with TypeDoc.

Table of Contents

• Getting Started
• Dependencies
• Developing
• Testing
• Documentation
• Publishing
• Credits
• License

Getting Started

Dependencies

What you need to run this seed:

• node and npm (Use NVM)
• Ensure you're running Node (v4.1.x+) and NPM (2.14.x+)

It will start a local demo server using webpack-dev-server which will watch, build (in-memory), and reload for you. The port will be displayed to you as http://localhost:8181.

Developing

Build files

• single run: npm run build
• build files and watch: npm run watch

Testing

1. Unit Tests

• single run: npm test
• live mode (TDD style): npm run test-watch

2. End-to-End Tests (aka. e2e, integration)

• single run:
  • in a tab, if not already running!: npm start
  • in a new tab: npm run webdriver-start
  • in another new tab: npm run e2e
• interactive mode:
  • instead of the last command above, you can run: npm run e2e-live
  • when debugging or first writing test suites, you may find it helpful to try out Protractor commands without starting up the entire test suite. You can do this with the element explorer.
  • you can learn more about Protractor Interactive Mode here

Documentation

You can generate api docs (using TypeDoc) for your code with the following:

npm run docs

Credits

• Project setup based on angular2-webpack
• Testing strategies found from Angular —  Unit Testing recipes by Gerard Sans

License

[Copyright Russell A. Farrow. All Rights Reserved.]