autofront 2.0.6 → 2.0.7
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 +48 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,43 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
[Gulp](https://gulpjs.com) settings for front-end projects.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Get started
|
|
6
6
|
|
|
7
|
-
###
|
|
8
|
-
|
|
9
|
-
Mainly the Gulp ones are the following:
|
|
10
|
-
|
|
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
|
-
|
|
15
|
-
### Support
|
|
16
|
-
|
|
17
|
-
The main supported packages/languages/libraries are:
|
|
7
|
+
### Install
|
|
18
8
|
|
|
19
|
-
|
|
20
|
-
|
|
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
|
-
|
|
27
|
-
## Usage
|
|
28
|
-
|
|
29
|
-
### Gulp file
|
|
30
|
-
|
|
31
|
-
`gulpfile.js` simply would look like:
|
|
32
|
-
|
|
33
|
-
```js
|
|
34
|
-
require('autofront');
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Optionally, to work with [HTML5 mode](https://docs.angularjs.org/api/ng/provider/$locationProvider#html5Mode), invoke `html5Mode` to prefix path of assets.
|
|
38
|
-
|
|
39
|
-
```js
|
|
40
|
-
var autofront = require('autofront');
|
|
41
|
-
autofront.html5Mode();
|
|
9
|
+
```sh
|
|
10
|
+
npm install --save-dev autofront
|
|
42
11
|
```
|
|
43
12
|
|
|
44
13
|
### Folder structure
|
|
@@ -47,7 +16,6 @@ Here is the essential basic organization you must to put in your project:
|
|
|
47
16
|
|
|
48
17
|
```text
|
|
49
18
|
├─ src/
|
|
50
|
-
│ ├─ fonts/
|
|
51
19
|
│ ├─ styles/
|
|
52
20
|
│ │ ├─ _variables.scss
|
|
53
21
|
│ │ ├─ index.less
|
|
@@ -60,6 +28,21 @@ Here is the essential basic organization you must to put in your project:
|
|
|
60
28
|
|
|
61
29
|
In `src`, only `index.html` is required. However, if Sass is used, both files must to exist.
|
|
62
30
|
|
|
31
|
+
### Gulp file
|
|
32
|
+
|
|
33
|
+
`gulpfile.js` simply would look like:
|
|
34
|
+
|
|
35
|
+
```js
|
|
36
|
+
require('autofront');
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Optionally, to work with [HTML5 mode](https://docs.angularjs.org/api/ng/provider/$locationProvider#html5Mode), invoke `html5Mode` to prefix path of assets.
|
|
40
|
+
|
|
41
|
+
```js
|
|
42
|
+
var autofront = require('autofront');
|
|
43
|
+
autofront.html5Mode();
|
|
44
|
+
```
|
|
45
|
+
|
|
63
46
|
### Dependencies
|
|
64
47
|
|
|
65
48
|
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:
|
|
@@ -90,14 +73,42 @@ One of these should to be named "app", ideally the main one.
|
|
|
90
73
|
|
|
91
74
|
### Domains
|
|
92
75
|
|
|
93
|
-
|
|
76
|
+
At least it should be defined the local one. See [the proper section](#domains-1).
|
|
77
|
+
|
|
78
|
+
## Usage
|
|
79
|
+
|
|
80
|
+
### Tasks
|
|
81
|
+
|
|
82
|
+
Mainly the Gulp ones are the following:
|
|
83
|
+
|
|
84
|
+
* `gulp` or `gulp serve` are for running a test server and develop with live reload.
|
|
85
|
+
* `gulp build` only builds the distributable version.
|
|
86
|
+
* With `gulp serve:dist`, a combination of the above is achieved: Specifically, the server runs this version but without reload.
|
|
87
|
+
|
|
88
|
+
### Domains
|
|
89
|
+
|
|
90
|
+
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"`.
|
|
94
91
|
|
|
95
92
|
These domain URLs must to appear listed in `package.json` with the property `domains` (optionally also `domainsAliases`, to assign domain name for each alias).
|
|
96
93
|
|
|
97
94
|
And, to capture the selected URL, put `{{AUTOFRONT_DOMAIN}}` where it would be located in your source code.
|
|
98
95
|
|
|
96
|
+
## Support
|
|
97
|
+
|
|
98
|
+
The main supported packages/languages/libraries are:
|
|
99
|
+
|
|
100
|
+
* [Bower](https://bower.io).
|
|
101
|
+
* Preprocessors:
|
|
102
|
+
* HTML: [Pug](https://pugjs.org).
|
|
103
|
+
* CSS:
|
|
104
|
+
* [Less](https://lesscss.org).
|
|
105
|
+
* [Sass](https://sass-lang.com).
|
|
106
|
+
* [AngularJS](https://angularjs.org).
|
|
107
|
+
|
|
99
108
|
## Pending
|
|
100
109
|
|
|
110
|
+
Improves to do:
|
|
111
|
+
|
|
101
112
|
* Once the server waits for changes, synchronize also the deletion of files (from `src`).
|
|
102
113
|
* Sass errors must not break the Gulp process (like Less).
|
|
103
114
|
* 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.
|