Tasty website cookware
WOK is a loosely opinionated boilerplate for web development built with flexibility and productivity in mind.
- HTML5 Boilerplate
- Static HTML templating with Nunjucks
- Sass 3.4+ with node-sass and CSS post-processing
- BEM-like naming convention
- Em based media-queries via sass-mq
- Gulp.js build and deploy workflow
- Bower
- Development server and asset live-reload with BrowserSync and Weinre remote debugging
- Incremental deploy with rsync or lftp
- Remote backup / rollback (UNIX SSH environments only)
- more to come... (project scaffolding, jade support)
- Node.js >= 0.12.7 (install wiki)
- bower (
sudo npm install -g bower
) - gulp cli (
sudo npm install -g gulp
)
Clone this repo:
git clone git://github.com/fevrcoding/wok.git
From project root:
bower install
(vendors)npm install
(gulp deps)
To enable JavaScript linting with eslint install npm packages globally:
npm install -g eslint@2.2.0 babel-eslint
Then install the required linter for your editor
For SCSS linting you need Ruby 2+ and scss-lint package:
gem install scss_lint
Then install the integration plugin for your editor
On a plain HTML project, the default configuration should work just fine. On other setups you might need to tweak some paths/options:
-
customize paths and options in
hosts.js
,paths.js
andproperties.js
files within thebuild/gulp-config
folder -
if needed, edit/add/remove tasks by editing tasks' configuration in
build/gulp-tasks/
.
Project sources are located into application
folder. Don't edit files in public
since they will be overwritten during the build process.
assets
+ fonts #Web Fonts
+ images #Images
+ javascripts #JavaScript files
+ stylesheets #SASS files
+ audio #audio files
+ video #video files
+ vendors #vendors packages installed by bower
documents #Markdown files or any other txt-like file to be included in HTMLs
fixtures #JSON files
views #HTML files
+ partials #View partials
+ templates #Nunjucks templates
index.nunj.html #Main views
...
With Nunjucks you can setup extensible page templates. See official docs for further details.
View partials in application/views/partials
are rendered to public
folder like every other file. To prevent rendering prepend a _
to the filename.
To limit performance issues, just first level sub-folders will be included in the parse process.
You may use bower to manage vendors. Installed packages will be stored into the application/assets/vendors
folder. It's up to you to provide dev and dist configuration to deploy vendors' files to public
.
From project root:
gulp serve
(builds in development mode, runs a static server on port 8000, watches for change and live-reloads assets)
To generate a production ready build add the --production
parameter:
gulp --production
By default WOK implements a simple set of deploy tasks requiring SSH remote access and rsync.
To deploy and rollback with rsync first setup your remote hosts in build/gulp-config/hosts.js
, then run:
#deploy to remote staging server. A backup of the deploy target folder (`paths.dist.root`) will be stored in `paths.backup`.
gulp deploy --remotehost=staging
#deploy a production build to remote production server
gulp deploy --production --remotehost=production
#rollback to the previous version in the remote production server
gulp remote --command=rollback --remotehost=production
If you are on a shared hosting with FTP access, you can switch to the more basic ftp
task, which uses lftp mirroring feature for incremental upload.
To switch to ftp mode, set deployStrategy
in build/gulp-config/properties.js
to 'ftp'
, then config hosts and run deploy commands as explained above.
Note Rollback and backup tasks won't be available with this configuration.
When paired with Phing or other deployment systems, remember to set buildOnly
to true
in build/gulp-config/properties.js
to delegate deploy tasks.
dev
: one time development build (also runs as default task)bump
: bumps semver version ofpackage.json
andbower.json
files. Accepts a--type
parameter with valuemajor|minor|patch|prerelease
. Defaults topatch
.
WOK was created by Marco Solazzi with contributions from Matteo Guidotto and Umberto Quintarelli.
Original work Copyright © 2014 Intesys S.r.l., released under the MIT license.
Modified work Copyright © 2015-2016 Marco Solazzi, released under the MIT license.