Sedona angularjs seed

How To

Start a new project from this seed

To start a new project from this seed, follow the following steps :

1. clone the desired release

   git clone --branch=<release> --depth=1 -o sdn-angular-seed \
       https://github.com/Sedona-Solutions/sdn-angularjs-seed.git <appFolder>
   

   See the CHANGELOG.md file for more informations about release.

   Use "master" instead of the release number if you want to start from the last commit (at your own risks).

2. cd to the folder and run npm install

3. change the project's data in the package.json file

4. change the app title in app/index.html and the app name in app/app.component.js > @Module > name.

5. remove all the README content

Start browserSync server

1. npm start
2. Browse to http://localhost:9000

Test

Unit Tests

run npm test to launch unit tests

Coverage reports

npm test automatically generates html and json coverage reports in target/coverage.

However, some mapping issues, due to BabelJS transpilation, still need to be fixed. Thereby, the previously mentioned reports are, for now, related to the ES5 transpiled JS code. Due to isparta deprecation and issues on it (douglasduteil/isparta#38), istanbul (gotwarlost/istanbul#429) and remap-istanbul (SitePen/remap-istanbul#1), there is still some work in progress on that case.

Related issue : #5.

EMFile issue

The npm test script could, on some systems, run into a EMFILE error. We use rolaveric/karma-systemjs but you can look at computmaxer/karma-jspm#97 for the description of a similar issue, and some resolutions.

End to end

run npm run wd to launch the webdriver server then, run npm run e2e to launch the e2e tests

Lint

run npm run lint to run eslint

Distribute

run npm run release bundle, cache busting, and minify

Engines

This project is strongly bound to :

• gulp
• system.js and jspm
• angularjs 1.5
• babel.js
• angular material (at a lower level)

The following engines may be required in the OS for some uses :

• istanbul
• remap-istanbul
• git

Versions

The project has been tested with the following environment:

• node v4.4.7
• npm v2.15.18
• jspm v0.16.42

Credits

SDN-AngularJS-Seed is created and maintained by Sedona.

It is available under the MIT Licence, more details in the LICENCE file.

We would like to thank the authors of the different libraries and bundle used in this solution.

• SDN-AngularJS-Seed was based on the angular1-systemjs-seed project, from Swimlane github:swimlane/angular1-systemjs-seed