Commit 6229c2ea authored by Philipp Nowinski's avatar Philipp Nowinski
Browse files

[TASK] add readme

parent 2c474e3f
[![sgalinski Internet Services]( "sgalinski Internet Services")](
# generator-gulp-sgalinski
## Installation
To use the sgalinski-generator you need to have node and npm installed. Furthermore, you should have
yeoman, gulp and bower installed globally. To do so, simply run
npm install -g yo
npm install -g gulp
Finally, to install the generator, run
npm install -g generator-gulp-sgalinski
## Usage
To run the generator, navigate to the directory you want to create your project in and run
yo gulp-sgalinski
This will generate all the files you need to run the toolchain, including a config.json file which you will have to adapt to your needs.
Here is what you get in detail:
* gulp | this folder contains the gulp tasks, split into several files, as well as the config.json
* gulpfile.js | The entry point for gulp
* package.json | The package file that contains all needed Node dependencies
* npm-shrinkwrap.json | This file contains all required dependencies, locked down to a specific version number ([learn more](
* | you can execute this file to ensure a proper installation of the toolchain. It will set up the correct version of Node, Gulp and the toolchain.
* .editorconfig | [Editorconfig]( is a great common way to synchronize editor settings across projects and IDEs/Editors. You can simply remove it, if you don't want to use it.
* .jshintrc | The configuration file for jshint
* .scss-lint.yml | The configuration file for Scss-Linters
### Useful tasks
#### Updating / Installing the toolchains dependencies
> This task will also be executed by the script
In order for the toolchain to work, you need to install all its dependencies. To do so, you can simply run the update task
(this will also work for the initial installation). Please note that you need to go to the website root
(e.g. web/ in order to execute this command.
npm run-script toolchain:update
This task will delete all previously installed dependencies and pull in the new ones.
#### Upgrading the toolchain
> **Caution!**
> This task is only meant for finishing up a new release of the toolchain itself.
To upgrade all dependencies and rewrite the npm-shrinkwrap, run the following command:
npm run-script toolchain:upgrade
The upgrade task will delete all dependencies, remove the current shrinkwrap and then install the new dependencies (as stated in package.json) and create a new shrinkwrap.
If you run this task, make sure that you know what you're doing, as updating dependencies can break stuff if not propperly tested!
## Configuration
To adjust the toolchain to a certain project, there is a [config.json](app/templates/gulp/config.json) file where the following options can be configured:
### directories
Holds the paths to the css, sass, javascript, images, sprites and inline-svgs, relative to the extensions root.
### abovethefold
Configuration for the critical path css.
* template: *path to the src template*
* dest: *path to the destination*
### js
* libraryPaths: *additional locations that should be searched when resolving CommonJS requires*
* excludeFromQa: *glob patterns with locations that hold JavaScript that does not need to be linted (vendor stuff)
### images
* optimize: *locations of user uploaded images that should be optimized*
### extensions
A list of extensions that should be included in the watch task. Please note, that the very first extension in this list is expected to be your project_theme.
## Usage
You can run a specific task on a specific component, or start a watcher that will fire up BrowserSync and run tasks when
source files change. Extensions that will be watched are defined in [config.json](gulp/config.json).
If you run a specific task, you need to specify the extension you want the task to run on with the --ext parameter.
gulp css --ext project_base
There are a few available tasks you need to remember:
### default/watch task
Starts a project wide watcher that will trigger the css/javascript task when you change any .scss, or .js-file and opens
the website in your browser, as a browsersync session (changed js and css will automatically get injected when recompiled).
*Hint:* If you already have a browsersync instance open in your browser, you can pass the argument -s to restart the session without opening a browser.
### sprite task
gulp sprites --ext [extensions name]
Triggers sprite generation inside the given directory.
* all sprite images are inside images/sprites, relative to the given path.
* all sprite images are PNGs.
* there is a sass directory, next to the images folder.
This task will generate a png inside the images folder, containing all the sprites and a .scss file inside the sass
folder, which will provide the necessary mixins. To use the sprites inside your SASS code, import the _sprite.scss file.
You can then use the following mixins:
// will output css for a sprite image 'box.png'
.element {
@sprite ($box);
The @sprite mixin already contains width and height. If you need these values for something else, use the @sprite-width
and @sprite-height mixins.
### css task
gulp css --ext [extension name]
Triggers css compilation inside the given directory. Note, that this task will also run the sprite task before it starts.
* all scss files are inside the sass directory, relative to the given path.
* all css files go into the stylesheets directory, relative to the given path.
### images task
gulp images --ext [extension name]
Optimizes all images for the given path.
* all images are inside the image directory, relative to the given path.
### optimize images in fileadmin and uploads
gulp images:uploaded
This task optimizes all images (png, jpg, gif) inside the folders you specified in the config.json file. You might want to
run this task on a regular basis to compress user uploaded media.
# Troubleshooting
## Strange errors during npm install
If you get strange errors during npm install, it might help to clear the npm cache. To do so, run 'npm cache clean', oder simply delete the .npm directory inside your home folder.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment