RobHameetman/shadow-ui

A UI pattern library with 100+ Web Components, automated screenshot testing, and MDX documentation with Storybook.

📦 @shadow-ui

This project is a curated collection of over 100 robust and modern Web Components built with Lit Element.

• 📦 @shadow-ui
  • 💼 Getting Started
    • 📚 Prerequisites
    • 📲 Installing
  • 🛥 Deployment
  • 🧾 Important Dependencies
  • 🏷 Versioning
  • 📜 Authors
  • 📄 License

💼 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

📚 Prerequisites

What things you need to install the software and how to install them

• Node v10+
• NPM v6+

📲 Installing

To install the project, clone and build the repo, then use npm to install dependencies for each package.

git clone git@bitbucket.org:shadow-ui.git
cd packages/eslint-config
npm i

🛥 Deployment

Each package is versioned and deployed independently with npm:

npm version patch
npm publish

🧾 Important Dependencies

• TypeScript - Implementation language
• NPM - Dependency Management
• Lit Element - Component Framework
• Storybook - UI Sandbox
• MDX - Component Documentation Format

🏷 Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

📜 Authors

• Robert Hameetman - engineering@robhameetman.com

See also the list of contributors who participated in this project.

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details