https://github.com/robhameetman/shadow-ui
A UI pattern library with 100+ Web Components, automated screenshot testing, and MDX documentation with Storybook.
https://github.com/robhameetman/shadow-ui
lerna-monorepo mdx pattern-library pre-alpha prs-welcome screenshot-testing storybook typescript ui webcomponents
Last synced: 25 days ago
JSON representation
A UI pattern library with 100+ Web Components, automated screenshot testing, and MDX documentation with Storybook.
- Host: GitHub
- URL: https://github.com/robhameetman/shadow-ui
- Owner: RobHameetman
- License: mit
- Created: 2019-10-26T22:33:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T19:33:29.000Z (about 3 years ago)
- Last Synced: 2025-09-28T06:01:53.843Z (5 months ago)
- Topics: lerna-monorepo, mdx, pattern-library, pre-alpha, prs-welcome, screenshot-testing, storybook, typescript, ui, webcomponents
- Language: JavaScript
- Homepage: https://www.robhameetman.com
- Size: 800 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
![@shadow-ui][header]
# 📦 @shadow-ui
This project is a curated collection of over 100 robust and modern Web Components
built with Lit Element.
- [📦 @shadow-ui](#%f0%9f%93%a6-shadow-ui)
- [💼 Getting Started](#%f0%9f%92%bc-getting-started)
- [📚 Prerequisites](#%f0%9f%93%9a-prerequisites)
- [📲 Installing](#%f0%9f%93%b2-installing)
- [🛥 Deployment](#%f0%9f%9b%a5-deployment)
- [🧾 Important Dependencies](#%f0%9f%a7%be-important-dependencies)
- [🏷 Versioning](#%f0%9f%8f%b7-versioning)
- [📜 Authors](#%f0%9f%93%9c-authors)
- [📄 License](#%f0%9f%93%84-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.
```bash
git clone git@bitbucket.org:shadow-ui.git
cd packages/eslint-config
npm i
```
## 🛥 Deployment
Each package is versioned and deployed independently with `npm`:
```bash
npm version patch
npm publish
```
## 🧾 Important Dependencies
* [TypeScript](https://www.typescriptlang.org/) - Implementation language
* [NPM](https://www.npmjs.com/) - Dependency Management
* [Lit Element](https://lit-element.polymer-project.org/) - Component Framework
* [Storybook](https://storybook.js.org/) - UI Sandbox
* [MDX](https://mdxjs.com/) - Component Documentation Format
## 🏷 Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/RobHameetman/packages/tags/).
## 📜 Authors
* **Robert Hameetman** - **
See also the list of [contributors](https://github.com/RobHameetman/shadow-ui/graphs/contributors)
who participated in this project.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md)
file for details
[header]: /.github/readme-root.png "@shadow-ui"