Light-weight and easy to use seed project for Angular 2 apps.
- Gulp fully automated workflow.
- Development and production environment targets.
- Official Angular 2 tutorial app implementation.
- Unit and E2E test samples.
- Code coverage report with TypeScript mapping.
- TypeScript linting, sourcemaps and transpilation (ES5).
- Sass linting, sourcemaps and transpilation.
TypeDoc documentation generator.(Currently disabled. See issue #26.)
$ git clone https://github.com/ghpabs/angular2-seed.git && cd angular2-seed
$ npm install
$ gulp build serve
Note: the serve task won't automatically launch the browser for you.
To view the app please open a new tab and go to http://localhost:8080/.
$ gulp clean: Remove generated folders -build,docsandcoverage.$ gulp unit: Run Karma against alltest/unit/**/*.spec.jsfiles.$ gulp e2e: Run Protractor against alltest/e2e/**/*.e2e.jsfiles. The project must be being served before running end-to-end tests.$ gulp build: Create distribution package. See environmenttargetsbelow.$ gulp serve: Start web-server and live-reload. See environmenttargetsbelow.
Default: NODE_ENV=development and PORT=8080.
$ gulp build serveis equivalent to$ NODE_ENV=development PORT=8080 gulp build serve.
$ NODE_ENV=production gulp build serve.
You might have noticed that we have quite a few files in our root folder. You might also be wondering why we need them and whether they are applicable to your use case. Here is a brief explanation:
- .travis.yml: Travis is our Continuos Integration (CI) server and this is its configuration file. We have added hooks to GitHub so automated tests will kick in after each commit.
- karma.shim.js: Unit testing Angular2 apps is still in its early days and this file helps us setup the test runner - Karma.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. When submitting a PR, make sure that the commit messages match the Angular conventions.
MIT