---
# Overdrive
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).
The components are housed in Storybook which provides interactive documentation,
UI playground, and interaction testing.
## Storybook
Visit the Overdrive Storybook site too access foundations, components and API
specifications:
### [overdrive.autoguru.io](http://overdrive.autoguru.io/)
## 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 Overdrive Provider with the theme you
want to use:
```jsx
import { OverdriveProvider, Button } from '@autoguru/overdrive';
;
```
The Overdrive Provider automatically applies global base styles to the body tag.
If you need more control over where the global base styles are applied, you can
also apply `data-od-base` to any element.
You can also customise the theme colours using the provider props:
```jsx
```
## Thanks
[Chromatic](https://www.chromatic.com) for providing visual regression testing.
## License
MIT ©[AutoGuru](https://www.autoguru.com.au/)
