Roadmunk's Design System Component Library

Getting Started

You want to use an awesome component library made by Roadmunkers, for Roadmunkers, you say? Well, you've come to the right place!

Requirements

• An application which is using React
• A package manager such as NPM or Yarn

Install the component library

(A) Option with NPM:

npm install @roadmunk/ds-components react react-dom styled-components styled-system

(B) Option with Yarn:

yarn add @roadmunk/ds-components react react-dom styled-components styled-system

Add the <AppProvider> component to your application

Note: It is recommended that this be a top level scope within your application such as a primary layout or router. In most cases, there should only be one instance of AppProvider in an application.

For example:

import React from 'react';

export const App = () => (
  <div className="App">
    <h1>Hello World</h1>
    <h2>Start editing to see some magic happen!</h2>
  </div>
);

becomes:

import React from 'react';
import { AppProvider, theme } from '@roadmunk/ds-components';

export const App = () => (
  <AppProvider theme={theme}>
    <div className="App">
      <h1>Hello World</h1>
      <h2>Start editing to see some magic happen!</h2>
    </div>
  </AppProvider>
);

Note: we also add the theme prop. This provides the theme styles from the design system to all design system components, as well as to any custom styled components you may want to write.

Component Usage

Visit the DS Storybook for documentation on components in the design system.

Contributing

Documentation for contributors lives in CONTRIBUTING.md.