Installing Locally

Welcome to the styleguide wiki! It's just a draft for now based on my experience installing it. Thomas may have different approach so please share your feedback here

1. Make sure the repo installed in a folder containing the other 2 repos components and scss as they're dependent and we'd like to connect them to each other locally to see local changes before commiting them
2. Install auerila CLI globally first: npm install aurelia-cli -g
3. In aurelia.json change "documentation"."source" to be like this:

"documentation": {
    "source": [
      "../scss/doc/*/*.md",
      "../components/doc/*/*.md"
    ]
  },

But make sure this change isn't commited as it's only helpful for seeing changes locally

4. Somehow the scss and components repos are linked with ssh link which isn't working so I changed them to:

"styleguide-web-components": "git+https://github.com/wholesale-design-system/components.git#master"

"wholesale-styleguide-scss": "git+https://github.com/wholesale-design-system/scss.git"

5. run au run --watch
6. http://localhost:9001/#/

One common issue is the router might stop working and all links freez, the current solution is to break the command (crtl+c) and re-run it again au run --watch