Skip to content

Getting started

Emmanuel Pire edited this page May 1, 2016 · 1 revision

1. You need a project with all components in a single directory

If you need one, just clone this example: https://github.com/lipsumar/dsf-example-project

$ git clone https://github.com/lipsumar/dsf-example-project.git

2. Install DSF

At the root of your project, run:

$ npm install design-system-framework

3. Run DSF

$ node node_modules/design-system-framework/cli.js

To make things easier, you can setup the following npm script in your package.json:

  "scripts": {
    "dsf": "node node_modules/design-system-framework/cli.js"
  },

and simply run:

$ npm run dsf

Configuration

You can configure DSF via a file called config.json at the root of your project and for each component.

See the wiki page for config.json.

Clone this wiki locally