arturoromeroslc / component-library

Official component library and storybook for Hack Oregon

Hack Oregon's React Component Library

---

Install

  $ npm i @hackoregon/component-library --save
  # or
  $ yarn add @hackoregon/component-library

Hack Oregon's React Component Library is a work in progress that encompasses platform components, a style guide, as well as data visualization components to be shared across projects.

For styling, we are using CSS Modules.

The components that end up here are either built using React Storybook or were ported into the Storybook dev environment. We believe this will allow us to make cross project compatible components.

Documentation for usage of these components and visual examples will be available at Hack Oregon's Storybook.

Contributing

Our issues/requests are tracked on waffle.io ==>

1. Get Node 6.5 + - I recommend using Node Version Manager.
2. git clone https://github.com/hackoregon/component-library.git
3. Install with yarn so that your npm packages are in sync.
4. npm start - spin up the storybook dev environment with hot module replacement.
5. npm test - run tests while coding
6. Code/Add components in the src folder with .test files alongside the source code.
7. Add stories in the story folder with .story extension.
8. Make a pull request to master from feature branches.