@antistatique/foehn

Fœhn

Fœhn (føn) is the design system build for the website of the State of Vaud.

Take a look at the documentation.

Changelog

Upgrading? Please read our CHANGELOG to learn what changes to expect in the latest version, whether that's new features, bug fixes, changes, or whatever else.

Issues

If you don't like the usual issues view, we have a Waffle board view.

Build tools

Toolbox and Bootstrap 4 is used to build fœhn.

$ npm install
$ ./node_modules/.bin/gulp serve

Quick Start

The following script lets you build, watch and serve the code.

$ git clone https://github.com/vdch/foehn.git
$ cd foehn
$ yarn
$ ./node_modules/.bin/gulp serve

Build

If you only want to build the code.

$ git clone https://github.com/vdch/foehn.git
$ cd foehn
$ yarn
$ /node_modules/.bin/gulp build

Deploy the styleguide

We deploy the styleguide to a gh-pages branch on Github. To do this, a simple command:

$ ./node_modules/.bin/gulp deploy --ghpages

Versioning

The project use Semantic Versioning.

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards-compatible manner, and
• PATCH version when you make backwards-compatible bug fixes.

How to bump version ?

To bump version use the following commands only after the changed have been merged on the master (more info):

• PATCH: $ npm version patch -m "Upgrade to %s for reasons"
• MINOR: $ npm version minor -m "Upgrade to %s for reasons"
• MAJOR: $ npm version major -m "Upgrade to %s for reasons"