README

Possum

Possum is a framework of React components optimized for teams that want to ship apps fast. It is a curated list of components that work together and have cohesive styles. One of our design goals is that you never have to research and handpick component packages. Whatever you need is already here.

A gallery of components is at https://possum.revelry.co.

Installation

To install the toolkit for use in your project:

npm install --save awesome-possum

Usage

You can import components and use components from the toolkit like:

import Col from 'awesome-possum/lib/Col'
import Row from 'awesome-possum/lib/Row'
import Callout from 'awesome-possum/lib/Callout'

function Hello() {
  return (
    <Row>
      <Col>
        <Callout>Hello, world.</Callout>
      </Col>
    </Row>
  )
}

See the example site at https://possum.revelry.co for more examples of how to use the components in your projects.

SCSS

We don't just provide JavaScript. We've built a set of SCSS styles for all the components. It is in the scss directory of the package. You can either copy it into your project's SCSS directory, or use a tool like sassy-npm-importer to import it from the package.

Configuration

At this time, there's no package level configuration-- all options as passed as props to the components at time of use.

Contributing and Development

See CONTRIBUTING.md for guidance on how to develop possum.

Bug reports and pull requests are welcome on GitHub at https://github.com/revelrylabs/possum. Check out CONTRIBUTING.md for more info.

Everyone is welcome to participate in the project. We expect contributors to adhere the Contributor Covenant Code of Conduct (see CODE_OF_CONDUCT.md).

Usage no npm install needed!