autofront 2.0.5 → 2.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,21 +8,21 @@
|
|
|
8
8
|
|
|
9
9
|
Mainly the Gulp ones are the following:
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
* `gulp` or `gulp serve` are for running a test server and develop with live reload.
|
|
12
|
+
* `gulp build` only builds the distributable version.
|
|
13
|
+
* With `gulp serve:dist`, a combination of the above is achieved: Specifically, the server runs this version but without reload.
|
|
14
14
|
|
|
15
15
|
### Support
|
|
16
16
|
|
|
17
17
|
The main supported packages/languages/libraries are:
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
19
|
+
* [Bower](https://bower.io).
|
|
20
|
+
* Preprocessors:
|
|
21
|
+
* HTML: [Pug](https://pugjs.org).
|
|
22
|
+
* CSS:
|
|
23
|
+
* [Less](https://lesscss.org).
|
|
24
|
+
* [Sass](https://sass-lang.com).
|
|
25
|
+
* [AngularJS](https://angularjs.org).
|
|
26
26
|
|
|
27
27
|
## Usage
|
|
28
28
|
|
|
@@ -60,6 +60,34 @@ Here is the essential basic organization you must to put in your project:
|
|
|
60
60
|
|
|
61
61
|
In `src`, only `index.html` is required. However, if Sass is used, both files must to exist.
|
|
62
62
|
|
|
63
|
+
### Dependencies
|
|
64
|
+
|
|
65
|
+
These ones are automatically built by [Gulp Useref](https://www.npmjs.com/package/gulp-useref), [Wiredep](https://www.npmjs.com/package/wiredep) and [Gulp Inject](https://www.npmjs.com/package/gulp-inject). Then, to reach this, `index.html` would have to look basically like:
|
|
66
|
+
|
|
67
|
+
```html
|
|
68
|
+
<!DOCTYPE html>
|
|
69
|
+
<html>
|
|
70
|
+
<head>
|
|
71
|
+
<!-- build:css styles/vendor.css -->
|
|
72
|
+
<!-- bower:css --><!-- endbower -->
|
|
73
|
+
<!-- endbuild -->
|
|
74
|
+
</head>
|
|
75
|
+
<body>
|
|
76
|
+
<!-- build:js scripts/vendor.js -->
|
|
77
|
+
<!-- bower:js --><!-- endbower -->
|
|
78
|
+
<!-- endbuild -->
|
|
79
|
+
<!-- build:js scripts/app.js -->
|
|
80
|
+
<!-- inject:js -->
|
|
81
|
+
<!-- endinject -->
|
|
82
|
+
<!-- endbuild -->
|
|
83
|
+
</body>
|
|
84
|
+
</html>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### AngularJS modules
|
|
88
|
+
|
|
89
|
+
One of these should to be named "app", ideally the main one.
|
|
90
|
+
|
|
63
91
|
### Domains
|
|
64
92
|
|
|
65
93
|
Running Gulp command, an additional parameter can be included (e.g.: `gulp --dev` o `gulp build --pro`) to indicate the domain of connection path. Defaults to local.
|
|
@@ -70,6 +98,6 @@ And, to capture the selected URL, put `{{AUTOFRONT_DOMAIN}}` where it would be l
|
|
|
70
98
|
|
|
71
99
|
## Pending
|
|
72
100
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
101
|
+
* Once the server waits for changes, synchronize also the deletion of files (from `src`).
|
|
102
|
+
* Sass errors must not break the Gulp process (like Less).
|
|
103
|
+
* Bower should be replaced as a dependency manager. It is currently [under maintenance](https://bower.io/blog/2017/how-to-migrate-away-from-bower/) and, therefore, its use is not recommended.
|