README.md

Incubator.with.Patternlab

This project is based on the Incentro Front-end Incubator project.

Project setting

• Assets Static files needed to render the layout and interaction of a project.
• Pattern library Html snippets documenting how to implement separate parts of this front-end project

Getting started

Quickstart

1. This project uses SASS, Node.js and Gulp to automate development. Please take a look at the Build dependencies section in this readme to make sure the latest versions are installed.

2. Install development dependencies npm install

3. Use any of the build commands described below, for example:

   gulp compile --minify - to create a production ready build of the Front-end code.

4. Paths and other configurations are set in the config.json file.

Build dependencies

Make sure the following dependencies are installed before using the build system.

Name	Version	Description	Quick install
Node.js	8.1.x	Used to automate builds of project	Windows: download and install via the Node.js website. Mac: 1. Install Homebrew 2. run brew install node
Npm	5.0.x	Manages Node.js dependencies	Automatically installed when installing Node.js. Use the command npm update npm -g to update version if needed. Check troubleshooting section if having troubles updating on a Windows machine.
Gulp	3.9.x	Build tool to define build tasks	1. Install Npm and NodeJs 2. run npm install -g gulp on commandline

Please look at the troubleshooting section if you are having trouble installing dependencies.

Build commands

Install build dependencies

This projects relies on NPM and bower for dependency management.

npm install

Building the project

Gulp is used to create a build version of the project.

gulp compile

Use the --minify modifier to create a production ready/minified version of the project.

gulp compile --minify

Please read the comments in gulpfile.js for a detailed description of the build steps used or execute:

gulp help

Development

Build the project, and run development server, a webbrowser will be opened with the build result. A new build will be reloaded automatically when changing src files

gulp serve

Clean environment

Some code changes require the build cache to be cleared. You can use the following command:

gulp clean

Configuration

• package.json development dependencies installed by npm install command
• gulpfile.js build process managed by gulp. Look into the gulp documentation for configuration options.

Directory structure

• src - project source files, does not include vendor packages
  • asset - Front-end dependency needed in order to implement html
    • font - fonts enabled in css
    • image - images used in layout
    • javascript - browserify enabled javascript (please look into bower.json for dependencies)
    • scss - styling files, structure based on DoCSSa
  • site - prototype site displaying
    • template - templates needing to be rendered by nunjucks
    • webroot - static files needing to be available in prototype
      • static - sample files, normally managed by the cms
  • pattern_library -
    • template - kss handlebars template to render pattern library

Troubleshooting

Running npm install on windows gives errors with node-gyp

In order to use the build:live preview functionality on windows you need to install Visual C++ runtime libraries. More information on this issue can be found in the browser sync documentation

Updating NPM on windows

In some situations the windows permission scheme will prevent an upgrade of npm via the npm update npm -g command. Use the following steps to fix this:

1. Open a command window with Administrator permissions
2. Navigate to the installation directory of Node.js ( most likely c:\Program Files\nodejs or c:\Program Files (x86)\nodejs )
3. Run npm install npm

Thanks to

This project is kickstarted with the Incentro Frontend Incubator

BEM naming example

.person {} .person__hand {} .person--female {} .person--female__hand {} .person__hand--left {}