sux-ds v0.0.2

Substrate Design System - Stencil Web Component Library

This repository contains only the web component library. Check out our Substrate DS Docs or the Substrate DS StoryBook for all Stencil components

The Design tokens are managed using Style Dictionary Github repository

Getting Started - DEVELOPMENT

To get the project running:

Install dependencies

npm install

To start development wit StencilJS & Storybook run start-dev in the terminal

npm run start-dev

Or run the Stencil and Storybook manually using:

npm run build
npm run start
npm run storybook

Getting Started - CONSUMING COMPONENTS

Substrate is not ready for use in production. Currently you will need to build and manually integrate components to experiment.

Check out our Substrate DS StoryBook to see they components in their current state.

Experiamental Use the webcomponent library to play around using unpkg by adding the following to your html head:

<script crossorigin type="module" src="https://unpkg.com/sux-ds@0.0.1/dist/substrate-ds/substrate-ds.esm.js"></script>

Contributing

Check out our roadmap to see what we're working on and where we need help.

We welcome contributions to this project. See contributing.md for an overview of contribution guidelines.

License

COPYRIGHT © 2021 Mike Kamminga & Esther Dingse Momin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

email: hello@phantasmagoria.in