eddiemonge / pebble

Pebble Design System

Pebble

A react-based design system built by iStreamPlanet

Documentation

Visit the Pebble documentation site for information.

Contribution and Support

Before opening an issue or pull request, please read the Contributing guide.

Development

See the Development guide for instructions on how to run Pebble locally for development.

Installation and Usage

To use Pebble, add the package to your package.json using your package manager of choice.

For yarn users:

$ yarn add @istreamplanet/pebble node-sass react-router-dom

For npm users:

npm install @istreamplanet/pebble node-sass react-router-dom --save

Include the Pebble foundation stylesheet in your layout template.

import '@istreamplanet/pebble/dist/Styles/foundation.scss';

Import the components into your application

import { Button, Card } from '@istreamplanet/pebble'`

Then add them in your React component as you would any other:

const MyComponent = () => (
  <Card>
    <Button>Submit</Button>
  </Card>
)

Have a look at the pebble.istreamplanet.net for component documentation.

Release History

See the Releases page.

License

Copyright © 2019 iStreamPlanet Co., LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.