Liip Web Styleguide
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
components
data
docs
public
theme
.editorconfig
.eslintrc.json
.gitignore
.npmignore
.release-it.json
.travis.yml
CHANGELOG.md
LICENSE
README.md
fractal.js
package-lock.json
package.json
server.js
webpack.common.js
webpack.dev.js
webpack.prod.js

README.md

Liip Styleguide

A living documentation of the components used, essentially, on liip.ch. The goal of this documentation is to illustrate all the elements available and therefor have an overview of the style and behavior of the interface of the website.

For more information about this project, visit styleguide.liip.ch.

Project setup

  1. Clone the repository
git clone git@github.com:liip/styleguide.git
  1. Run npm install to install dependencies
  2. Run npm start to start the development server

Go to localhost:3000.

Build a static version

npm run build

The output goes to the dist directory.

Release a new version

Bump the version in package.json, update the Changelog, build, commit, tag, push and deploy automatically:

npm run release [patch|minor|major]

Build is done in the dist folder and website deployed to styleguide.liip.ch.

Contribute

Commit guidelines

Follow the Angular commit guidelines to help generating a clean and readable Changelog.

Issues

Use issues to report anything, from bugs to feature requests.

Code

To contribute to this project, open a pull request.

If you make changes in the JavaScript, setup EsLint in your editor or run npm run lint to ensure consistency.

You might be interested in the coding standards applied to this project.