Skip to content

Commit cad588b

Browse files
committed
update readme
1 parent 7a58c29 commit cad588b

5 files changed

Lines changed: 33 additions & 12 deletions

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# ng-espack-boilerplate
2-
Angular 1.4.8 + ES6 application boilerplate [![Build Status](https://travis-ci.org/ziyasal/ng-espack-boilerplate.svg)](https://travis-ci.org/ziyasal/ng-espack-boilerplate) [![Coverage Status](https://coveralls.io/repos/ziyasal/ng-espack-boilerplate/badge.svg?branch=master&service=github)](https://coveralls.io/github/ziyasal/ng-espack-boilerplate?branch=master)
2+
Angular 1.4.8 + ES6 application boilerplate with testing practices [![Build Status](https://travis-ci.org/ziyasal/ng-espack-boilerplate.svg)](https://travis-ci.org/ziyasal/ng-espack-boilerplate) [![Coverage Status](https://coveralls.io/repos/ziyasal/ng-espack-boilerplate/badge.svg?branch=master&service=github)](https://coveralls.io/github/ziyasal/ng-espack-boilerplate?branch=master)
33

4+
##Features
45
- [x] [Webpack](https://webpack.github.io/) Setup
56
- [x] [Babel](https://babeljs.io/)
67
- [x] [Isparta](https://github.com/douglasduteil/isparta) [Instrumenter Loader](https://github.com/ColCh/isparta-instrumenter-loader)
@@ -21,3 +22,30 @@ Angular 1.4.8 + ES6 application boilerplate [![Build Status](https://travis-ci.o
2122
- [x] Directive test
2223
- [ ] Filter Test
2324
- [ ] Http interceptor Test
25+
26+
27+
##Install
28+
To use it, clone repo and install npm and bower packages;
29+
30+
```
31+
git clone https://github.com/ziyasal/ng-espack-boilerplate.git
32+
cd ng-espack-boilerplate
33+
npm install
34+
bower install
35+
```
36+
37+
## Development
38+
All scripts are run with `npm run [script]`, for example: `npm run test`.
39+
40+
`build` - generate a minified build to `public` folder
41+
`test` - run all tests
42+
`test:live` - continuously run unit tests watching for changes
43+
`eslint:app` - lint code in `app` folder
44+
`eslint:tests` - lint code in `tests` folder
45+
46+
See what each script does by looking at the scripts section in `package.json`.
47+
48+
License
49+
=======
50+
51+
Code and documentation are available according to the `MIT` License (see [LICENSE](https://github.com/ziyasal/ng-espack-boilerplate/blob/master/LICENSE)).

app/home/views/index.tpl.html

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
<div class="jumbotron">
2-
<h1>AngularJS + ES6 boilerplate application using Webpack</h1>
3-
<small>coding4fun</small>
4-
<p class="lead">
5-
Hello world..
6-
</p>
7-
</div>
8-
9-
<br/>
1+
<h3>AngularJS + ES6 boilerplate application using Webpack</h3>
102

113
<message-list messages="vm.messages" header="'Messages'"></message-list>

app/templates.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gulpfile.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ gulp.task('build-dev', ['tpl-cache', 'webpack:build-dev'], function () {
2525
});
2626

2727
gulp.task('webpack:dev-server', function (callback) {
28+
gulp.watch(['app/**/*'], ['tpl-cache']);
29+
2830
new WebpackDevServer(devCompiler, {
2931
contentBase: 'public',
3032
hot: true,

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
"main": "index.js",
66
"scripts": {
77
"build": "webpack --config webpack.build.js --bail -p",
8-
"dev": "webpack-dev-server --history-api-fallback --inline --progress",
98
"test": "karma start",
109
"test:live": "karma start --auto-watch --no-single-run",
1110
"preupdate-webdriver": "npm install",

0 commit comments

Comments
 (0)