govau / design-system-starter

🚀 The Australian Government Design System - Starter

Home Page:https://design-system-starter.apps.b.cld.gov.au/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

no more update?

iijiang opened this issue · comments

from the docs says npm install? install what? is this a no more update?

@iijiang This will give you an instance where you can prototype, tweak variables and get a rough idea of the Uikit. It will also generate the CSS/JS from the Uikit if you would like to use those, however I would recommend using the Uikit for any integration with a real project as it will allow immutable versioned components.

The documentation of the starter kit is going to updated soon. I understand it's not in the best state.

If you are using a windows computer there is a pull request ( #1 ) which should fix up some issues as well.

I'll try and outline my process here to help you:

  1. git clone https://github.com/govau/uikit-starter.git
  2. cd uikit-starter
  3. npm install
  4. If you are using Windows, update your package.json
  5. npm run watch