autofront 2.0.5 → 2.0.8

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.
Files changed (2) hide show
  1. package/README.md +76 -37
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,29 +2,31 @@
2
2
 
3
3
  [Gulp](https://gulpjs.com) settings for front-end projects.
4
4
 
5
- ## Behaviour
5
+ ## Get started
6
6
 
7
- ### Tasks
8
-
9
- Mainly the Gulp ones are the following:
7
+ ### Install
10
8
 
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.
9
+ ```sh
10
+ npm install --save-dev autofront
11
+ ```
14
12
 
15
- ### Support
13
+ ### Folder structure
16
14
 
17
- The main supported packages/languages/libraries are:
15
+ Here is the essential basic organization you must to put in your project:
18
16
 
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).
17
+ ```text
18
+ ├─ src/
19
+ │ ├─ styles/
20
+ │ │ ├─ _variables.scss
21
+ │ │ ├─ index.less
22
+ │ │ └─ index.scss
23
+ │ └─ index.html
24
+ ├─ bower.json
25
+ ├─ gulpfile.js
26
+ └─ package.json
27
+ ```
26
28
 
27
- ## Usage
29
+ In `src`, only `index.html` is required. However, if Sass is used, both files must to exist.
28
30
 
29
31
  ### Gulp file
30
32
 
@@ -41,35 +43,72 @@ var autofront = require('autofront');
41
43
  autofront.html5Mode();
42
44
  ```
43
45
 
44
- ### Folder structure
46
+ ### Dependencies
47
+
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:
49
+
50
+ ```html
51
+ <!DOCTYPE html>
52
+ <html>
53
+ <head>
54
+ <!-- build:css styles/vendor.css -->
55
+ <!-- bower:css --><!-- endbower -->
56
+ <!-- endbuild -->
57
+ </head>
58
+ <body>
59
+ <!-- build:js scripts/vendor.js -->
60
+ <!-- bower:js --><!-- endbower -->
61
+ <!-- endbuild -->
62
+ <!-- build:js scripts/app.js -->
63
+ <!-- inject:js -->
64
+ <!-- endinject -->
65
+ <!-- endbuild -->
66
+ </body>
67
+ </html>
68
+ ```
45
69
 
46
- Here is the essential basic organization you must to put in your project:
70
+ ### AngularJS modules
47
71
 
48
- ```text
49
- ├─ src/
50
- │ ├─ fonts/
51
- │ ├─ styles/
52
- │ │ ├─ _variables.scss
53
- │ │ ├─ index.less
54
- │ │ └─ index.scss
55
- │ └─ index.html
56
- ├─ bower.json
57
- ├─ gulpfile.js
58
- └─ package.json
59
- ```
72
+ One of these should to be named "app", ideally the main one.
60
73
 
61
- In `src`, only `index.html` is required. However, if Sass is used, both files must to exist.
74
+ ### Domains
75
+
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.
62
87
 
63
88
  ### Domains
64
89
 
65
- 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.
90
+ Running Gulp command, an additional parameter can be included (e.g.: `gulp --dev` or `gulp build --pro`) to indicate the domain of connection path. Defaults to `--local`.
66
91
 
67
- These domain URLs must to appear listed in `package.json` with the property `domains` (optionally also `domainsAliases`, to assign domain name for each alias).
92
+ These domain URLs must to appear in `package.json` listed in the property `domains` (optionally also `domainsAliases`, to assign domain name for each alias).
68
93
 
69
94
  And, to capture the selected URL, put `{{AUTOFRONT_DOMAIN}}` where it would be located in your source code.
70
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
+
71
108
  ## Pending
72
109
 
73
- - Once the server waits for changes, synchronize also the deletion of files (from `src`).
74
- - Sass errors must not break the Gulp process (like Less).
75
- - 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.
110
+ Improves to do:
111
+
112
+ * Once the server waits for changes, synchronize also the deletion of files (from `src`).
113
+ * Sass errors must not break the Gulp process (like Less).
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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "autofront",
3
- "version": "2.0.5",
3
+ "version": "2.0.8",
4
4
  "description": "Gulp settings for front-end projects.",
5
5
  "main": "index.js",
6
6
  "scripts": {