@iambrennanwalsh/design-system
v0.1.2
Published
My personal design system.
Downloads
1
Readme
@iambrennanwalsh/design-system
My personal design system.
Overview
- Type Checking, Linting, and Formatting
The components are implemented in TypeScript, ESLint provides linting capabilities, and Prettier is used for formatting.
For development, I recommend using Visual Studio Code. The included /.vscode
directory contains an extensions.json
file that provides a list of recommended extensions. These include extensions for EditorConfig, ESLint, Prettier, and NPM Scripts. The minimal configuration is also included to get everything working as intended.
- Storybook
All design system components are documented via a storybook. To start up the storybook run..
npm run serve
This command launches a development server on localhost:8000 via @web/dev-server.
Installation
Use the NPM or Yarn package manager to install @iambrennanwalsh/design-system.
npm install @iambrennanwalsh/design-system
// or
yarn add @iambrennanwalsh/design-system
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.