Boilerplate setup for developping styleguides. Based on FLOW - the frontend boilerplate/utility-belt/workflow running on Gulp by Gwen Vanhee. Build with love for everyday use at Little Miss Robot
Default Styleguide
=================
Frontend boilerplate/utility-belt/... running on Gulp, Sass & nunjucks templates
Build with love @littlemissrobot to kickstart projects
Principle
---------
* development/ contains application code and assets
* fonts contains the webfonts and the assets to generate the iconfont
* img contains all images used in the project
* js javascript files
* meta contains some meta tags that are needed for creating deploys (.htaccess, favicons, ...)
* sass the sass files for styling (see _Philosophy_ for additional info on the nested folderstructure)
* templates Nunjucks templates (same folder-structure philosophy as for sass/)
* deploy/ contains the built application
* dist/ contains build files for CDN use.
* Gulpfile.js configures Gulp tasks
* gulp/ contains the separated gulp tasks
* gulp/config/config-default.json Contains default keys for running the gulp tasks. (see _installing_ for further info)
* package.json contains npm dependencies
Installing
----------
Prerequisites for installing
* Node (for gulp build environment)
* NPM (for package management)
please read the package.json file for additional dependencies.
###How to get started
1) If not present on your system (aka install once)
* install Node + NPM
* (sudo) npm install gulp -g: install Gulp (globaly)
2) Navigate to your project folder (aka install for each project)
* (sudo) npm install: install npm dependencies
gulp/config/config-default.json.
config.json. This new file is your own
PROJECT_ project related naming and metadata
FTP set to true to deploy the build to a ftp environment using the credentials that follow.
DIST_FTP set to true to deploy the CDN dist to to a FTP environment using the credentials that follow.
SLACK set to true to send a message to a slack channel using a webhook once a deploy is done succesfully.
GIT TODO....
gulp same as gulp server but opens the new page in a browser window automatically (being lazy is not a crime)
gulp server to start a web server (including livereload, running on port 9000)
gulp build to build a production-ready application in the deploy/ folder
gulp iconfont to create an icon font from a set of svg-sources that are found in developent/fonts/icon-sources/.svg
gulp semver -m '[your message]' [ --patch | --minor | --major ] gives a versionbump to version.json using the parameters given.
gulp distribute Creates a dist/ deploy and pushes it to the DIST_FTP if configured
gulp deploy -m '[your message]' [ --patch | --minor | --major ] The master task to make builds. Keep in mind that following tasks are a dependency from this task:
build + the deploy/ is pushed to the FTP if configured
semver Make shure to give the right parameters
DIST_FTP is configured, than distribute is executed as well