You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,12 +16,13 @@ WOK is a loosely opinionated boilerplate for web development built with flexibil
16
16
* Development server and asset live-reload with [BrowserSync](http://www.browsersync.io/) and [Weinre](http://people.apache.org/~pmuellr/weinre/) remote debugging
17
17
* Incremental deploy with [rsync](https://rsync.samba.org/) or [lftp](http://lftp.yar.ru/)
* more to come... (project scaffolding, jade support)
19
+
20
20
21
21
22
22
## Requirements
23
23
24
-
* Node.js >= 4.0.0 (we strongly succest to use something like [nvm](https://github.com/creationix/nvm))
24
+
* Node.js >= 4.0.0 (we strongly suggest to use something like [nvm](https://github.com/creationix/nvm))
25
+
* npm3 (`npm install -g npm@3`)
25
26
* bower (`npm install -g bower`)
26
27
* gulp cli (`npm install -g gulp`)
27
28
@@ -40,23 +41,23 @@ From project root:
40
41
41
42
#### JavaScript linting
42
43
43
-
Wok comes with preconfigured [eslint](http://eslint.org/) linting based on the [airbnb base preset](https://www.npmjs.com/package/eslint-config-airbnb-base).
44
+
Wok comes with preconfigured [eslint](http://eslint.org/) linting based on the [airbnb base preset](https://www.npmjs.com/package/eslint-config-airbnb-base).
44
45
You can lint your JavaScript files by running: `gulp lint:js`.
45
-
46
+
46
47
If you want to use _in editor_ linting, please follow the setup instructions [your editor](http://eslint.org/docs/user-guide/integrations#editors)
47
48
48
49
*Note*: eslint preset expects ES6 syntax, anyway Wok doesn't provide any transpiler (ie: Babel) out of the box. The wiki provides recipes to use [webpack 1.x](https://github.com/fevrcoding/wok/wiki/Gulp:-webpack-and-ES6) or [Browserify](https://github.com/fevrcoding/wok/wiki/Gulp:-browserify-and-ES6)
49
50
50
51
#### SCSS linting
51
52
52
-
For **SCSS linting** you can choose [stylelint](http://stylelint.io/) or [scss-lint](https://github.com/brigade/scss-lint).
53
-
The latter
53
+
For **SCSS linting** you can choose [stylelint](http://stylelint.io/) or [scss-lint](https://github.com/brigade/scss-lint).
54
+
The latter
54
55
55
-
Linting via **stylelint** is available as a gulp task: `gulp list:scss`.
56
+
Linting via **stylelint** is available as a gulp task: `gulp lint:scss`.
56
57
Available editor extensions for in-editor linting are listed [here](http://stylelint.io/user-guide/complementary-tools/)
57
58
58
-
Linting via **scss-lint** requires [Ruby 2+](http://rubyinstaller.org/downloads/) installed on your system and the global scss-lint gem (`gem install scss_lint`)
59
-
It's available as a npm script: `npm run scss-lint`.
59
+
Linting via **scss-lint** requires [Ruby 2+](http://rubyinstaller.org/downloads/) installed on your system and the global scss-lint gem (`gem install scss_lint`)
60
+
It's available as a npm script: `npm run scss-lint`.
60
61
Available editor extensions for in-editor linting are listed [here](https://github.com/brigade/scss-lint#editor-integration) for your editor
61
62
62
63
## Configuration
@@ -119,22 +120,22 @@ To generate a production ready build add the `--production` parameter:
119
120
120
121
121
122
gulp --production
122
-
123
+
123
124
124
125
### Deploy and rollback:
125
126
126
127
#### SSH and rsync
127
128
128
-
By default WOK implements a simple set of deploy tasks requiring SSH remote access and [rsync](https://rsync.samba.org).
129
+
By default WOK implements a simple set of deploy tasks requiring SSH remote access and [rsync](https://rsync.samba.org).
129
130
130
131
To deploy and rollback with rsync first setup your remote hosts in `build/gulp-config/hosts.js`, then run:
131
-
132
+
132
133
#deploy to remote staging server. A backup of the deploy target folder (`paths.dist.root`) will be stored in `paths.backup`.
133
134
gulp deploy --remotehost=staging
134
-
135
+
135
136
#deploy a production build to remote production server
136
137
gulp deploy --production --remotehost=production
137
-
138
+
138
139
#rollback to the previous version in the remote production server
@@ -154,11 +155,11 @@ When paired with Phing or other deployment systems, remember to set `buildOnly`
154
155
155
156
*`dev`: one time development build (also runs as default task)
156
157
*`lint`: runs both JavaScript and SCSS linters
157
-
*`bump`: bumps semver version of `package.json` and `bower.json` files. Accepts a `--type` parameter with value `major|minor|patch|prerelease`. Defaults to `patch`.
158
+
*`bump`: bumps semver version of `package.json` and `bower.json` files. Accepts a `--type` parameter with value `major|minor|patch|prerelease`. Defaults to `patch`.
158
159
159
160
## Project Info
160
161
161
162
WOK was created by [Marco Solazzi](https://github.com/dwightjack) with contributions from [Matteo Guidotto](https://github.com/mguidotto) and [Umberto Quintarelli](https://github.com/quincia).
0 commit comments