https://github.com/autoguru-au/overdrive

🚗💨 AutoGuru's design system
https://github.com/autoguru-au/overdrive

component design-system front-end library react scss storybook styleguide typescript ui

Last synced: about 2 months ago
JSON representation

🚗💨 AutoGuru's design system

• Host: GitHub
• URL: https://github.com/autoguru-au/overdrive
• Owner: autoguru-au
• License: mit
• Created: 2019-03-06T02:16:25.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T05:12:14.000Z (about 2 months ago)
• Last Synced: 2024-07-29T05:50:31.380Z (about 2 months ago)
• Topics: component, design-system, front-end, library, react, scss, storybook, styleguide, typescript, ui
• Language: TypeScript
• Homepage: http://overdrive.autoguru.io
• Size: 11.3 MB
• Stars: 42
• Watchers: 2
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-list - overdrive - au | 35 | (TypeScript)

README

        


  

    

  





	

	



---

# Overdrive

Overdrive is a product component library and design system for AutoGuru, built

with React, TypeScript, Vanilla Extract, and Storybook.

[Storybook playground](https://overdrive.autoguru.io/).

Overdrive is a product component library, and design system for AutoGuru. Built

with [React](https://github.com/facebook/react),

[TypeScript](https://github.com/Microsoft/typescript),

[Vanilla Extract](https://github.com/vanilla-extract-css/vanilla-extract/), and

[Storybook](https://github.com/storybooks/storybook).

## Usage

To use Overdrive in your project, install it via yarn:

```sh

yarn add @autoguru/overdrive \

	react react-dom

```

Then, import the reset and configure the OverdriveProvider with the theme you

want to use:

```jsx

import '@autoguru/overdrive/reset';

// It is important that the reset import happens before any of this.

import { baseTheme } from '@autoguru/overdrive/lib/themes';

import { OverdriveProvider, Button } from '@autoguru/overdrive';

	Hello World

;

```

Documentation

For more information on Overdrive's API and usage, check out the

[docs](http://overdrive.autoguru.io/?path=/documentation/).

## Thanks

[Chromatic](https://www.chromaticqa.com) for providing component screenshot

testing.

## License

MIT © [AutoGuru](https://www.autoguru.com.au/)