@luxuryescapes/ui

Luxury Escapes UI

Usage no npm install needed!

<script type="module">
  import luxuryescapesUi from 'https://cdn.skypack.dev/@luxuryescapes/ui';
</script>

README

Luxury Escapes UI

A UI library that implements the artefacts available in the design system’s Sketch file.

Running storybook

If on first install:

$ yarn install

Then:

$ yarn run storybook

Then browse to http://localhost:6006.

Development

Local compoenents development should be done by running storybook.

For development in tandem with applications:

  • Run $ yarn link from within this repo.
  • Run $ yarn link @luxuryescapes/ui from within the repo that’s sourcing this library.
  • Whatever modifications that are made in here are commited.
  • Bump the version in package.json, then run yarn install again so the lock file gets updated. Commit both along with the pull request containing the changes.
  • Once merged, run npm publish so the new version is pushed to wherever it’s hosted.