Skip to content

Commit c6373e5

Browse files
committed
Fixed livereload on adding new files/deleting during development.
Added mirror delete. Fixed broken reference to the latest version of AngularUI Router in bower.json. Removed unused plugins from package.json. Added comments to gulpfile. Moved configuration to separate JSON file. Updated README.md.
1 parent 4ab3ff2 commit c6373e5

6 files changed

Lines changed: 248 additions & 207 deletions

File tree

README.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
# ng-devstack v0.1.0
1+
# ng-devstack v0.2.0
22

33
#### Everything a front-end developer needs to simplify building AngularJS applications.
44

55
## Why ng-devstack?
66

77
This project has been inspired by another great concept [ngBoilerplate](http://joshdmiller.github.io/ng-boilerplate/), allowing to create modern web applications in AngularJS. It follows all the best practices introduced in ngBoilerplate such as component/feature-oriented directory structure, intelligent build system, etc. However, I decided to improve it a little bit and create my own boilerplate from scratch since I missed some basic features like:
88

9-
* applying changes in real-time on adding new files to project,
10-
* image optimization,
11-
* remove redundant code on compiling output HTML,
12-
* plus ngBoilerplate hasn't been updated for months.
9+
- applying changes in real-time on adding new files to project,
10+
- image optimization,
11+
- remove redundant code on compiling output HTML,
12+
- plus ngBoilerplate hasn't been updated for months.
1313

1414
Now this all has been made possible. Please welcome **ng-devstack**!
1515

1616
## Features
1717

18-
* integration with gulp,
19-
* package management with Bower,
20-
* feature-oriented directory structure,
21-
* Livereload fully handled server-side with NodeJS/Express (without installing additional extensions for browsers),
22-
* real-time applying changes to website on adding new files (forget about manual rebuild the app),
23-
* caching AngularJS templates to avoid additional server requests,
24-
* pre-minifying AngularJS files to fix AngularJS' dependency injection upon minification,
25-
* support for SASS (including Twitter Bootstrap official port to SASS),
26-
* support for JSHint,
27-
* minify JS/CSS/HTML,
28-
* remove logging (`console.log()`, etc.) from compiled JS code,
29-
* image optimization on build (see *Additional Info* for details),
30-
* `html5Mode` support (see *Additional Info* for details),
31-
* integration with AngularUI Router & AngularUI Bootstrap.
18+
- integration with gulp,
19+
- package management with Bower,
20+
- feature-oriented directory structure,
21+
- Livereload fully handled server-side with NodeJS/Express (without installing additional extensions for browsers),
22+
- real-time applying changes to website on adding/deleting files (forget about manual rebuild the app),
23+
- caching AngularJS templates to avoid additional server requests,
24+
- pre-minifying AngularJS files to fix AngularJS' dependency injection upon minification,
25+
- support for SASS (including Twitter Bootstrap official port to SASS),
26+
- support for JSHint,
27+
- JS/CSS/HTML minification,
28+
- remove logging (`console.log()`, etc.) from compiled JS code,
29+
- image optimization (see *Additional Info* for details),
30+
- `html5Mode` support (see *Additional Info* for details),
31+
- integration with AngularUI Router & AngularUI Bootstrap.
3232

3333
## Requirements
3434

35-
* Ruby
36-
* NodeJS
37-
* Bower
35+
- Ruby
36+
- NodeJS
37+
- Bower
3838

3939
## Installation
4040

@@ -83,15 +83,19 @@ $ gulp
8383
```
8484

8585
## Additional info
86+
87+
Vendor files downloaded with Bower can be added manually by editing `'vendor_files'` section in `config.json` file.
88+
8689
If you would like to enable AngularJS HTML5 mode, you have to uncomment 2 lines in `src/app/app.js` and `server.js`:
87-
* `src/app/app.js`:
90+
91+
- `src/app/app.js`:
8892

8993
>
9094
```
9195
// $locationProvider.html5Mode(true);
9296
```
9397

94-
* `server.js`:
98+
- `server.js`:
9599

96100
>
97101
```
@@ -105,12 +109,14 @@ In addition, image optimization is turned off by default but in case you need it
105109
// .pipe(plugins.imagemin({ optimizationLevel: 5, progressive: true }))
106110
```
107111

112+
## Known issues
113+
114+
- Outdated libsass in node-sass. This is a main cause of a bug with compiling Twitter Bootstrap SASS to CSS (see [this](https://github.com/andrew/node-sass/issues/233) thread and [this](https://github.com/dlmanning/gulp-sass/issues/1) for details). Not a gulp-sass issue! Temporarily using Ruby version (slower but stable).
115+
108116
## TODO
109117

118+
- replace Ruby SASS compiler with NodeJS equivalent
119+
- add source maps support for SASS & JS
110120
- add authorization service
111121
- add E2E testing (Karma/Protractor)
112-
- add source maps support for SASS & JS
113122
- improve images/SVG optimization
114-
- update gulp configuration
115-
- add more comments to gulpfile
116-
- improve README.md

bower.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "ng-devstack",
3-
"version": "0.1.0",
3+
"version": "0.2.0",
44
"devDependencies": {
55
"angular": "~1.2.12",
66
"angular-bootstrap": "~0.10.0",
77
"angular-mocks": "~1.2.12",
8-
"angular-ui-router": "0.2.7",
8+
"angular-ui-router": "0.2.8-bowratic-tedium",
99
"angular-ui-utils": "~0.1.1",
1010
"bootstrap-sass-official": "latest"
1111
},

config.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"app" : "src",
3+
"build" : "build",
4+
"dist" : "dist",
5+
6+
"paths" : {
7+
"scripts" : "src/+(app|common)/**/*.js",
8+
"templates" : [
9+
"src/app/**/*.tpl.html",
10+
"src/common/**/*.tpl.html"
11+
],
12+
"sass" : "src/+(sass|app|common)/**/*",
13+
"assets" : "src/assets/**",
14+
"html" : "src/index.html"
15+
},
16+
17+
"vendor_files" : {
18+
"js": [
19+
"vendor/angular/angular.js",
20+
"vendor/angular-ui-router/release/angular-ui-router.js",
21+
"vendor/angular-bootstrap/ui-bootstrap-tpls.js"
22+
],
23+
"css": [
24+
],
25+
"assets": [
26+
"vendor/bootstrap-sass-official/vendor/assets/fonts/**/*"
27+
]
28+
}
29+
}

0 commit comments

Comments
 (0)