https://github.com/anarock/pebble

A set of lightweight and accessible React components.
https://github.com/anarock/pebble

design-system hacktoberfest-accepted react

Last synced: 3 months ago
JSON representation

A set of lightweight and accessible React components.

• Host: GitHub
• URL: https://github.com/anarock/pebble
• Owner: anarock
• Created: 2018-07-04T12:26:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-04T12:28:02.000Z (3 months ago)
• Last Synced: 2024-11-04T13:29:15.455Z (3 months ago)
• Topics: design-system, hacktoberfest-accepted, react
• Language: TypeScript
• Homepage: https://pebble-web.netlify.com/
• Size: 5.53 MB
• Stars: 58
• Watchers: 13
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

• awesome-list - pebble

README

        
# pebble

[![Greenkeeper badge](https://badges.greenkeeper.io/anarock/pebble.svg)](https://greenkeeper.io/)

[![Build Status](https://www.travis-ci.com/anarock/pebble.svg?branch=master)](https://www.travis-ci.com/anarock/pebble)

A design system comprising of component and utilities creating using React.

It consists of:

- [pebble-web](./packages/pebble-web)

- [pebble-shared](./packages/pebble-shared)

### Development

Install yarn globally.

```$xslt

npm i -g yarn

```

- Clone the repo.

- Install deps `yarn install`

- Run `yarn lerna bootstrap` at the root of the directory.

- Run `yarn storybook` to look at the preview of all the components and start development.

- To run tests, run `yarn build` before `yarn jest`

## Acknowledgements

We use [Chromaticqa](https://www.chromaticqa.com/) for visual regression testing and it is awesome.

## License

MIT