# Orbit-components

Orbit-components is a React component library to help developers build travel products.
Orbit aims to bring order and consistency to all of our products and processes. We elevate the user experience and increase the speed and efficiency of how we design and build products.

## Installation

`orbit-components` is an [npm package](https://www.npmjs.com/package/@kiwicom/orbit-components).

Run [npm](https://www.npmjs.com/) to add the package to your project:

`npm install --save @kiwicom/orbit-components`

or do so with [Yarn](https://yarnpkg.com/):

`yarn add @kiwicom/orbit-components`

## Usage

1. Import the fonts that are used in `orbit-components`:

   ```html
   <link
     href="https://fonts.googleapis.com/css?family=Roboto:400,400i,500,500i,700"
     rel="stylesheet"
   />
   ```

   Or via CSS:

   ```css
   @import url("https://fonts.googleapis.com/css?family=Roboto:400,400i,500,500i,700");
   ```

2. Include any of our components in your project and use it:

   ```jsx
   import Alert from "@kiwicom/orbit-components/lib/Alert";

   <Alert>Hello World!</Alert>;
   ```

For a live preview, check out our [Storybook](https://kiwicom.github.io/orbit/) or [orbit.kiwi](https://orbit.kiwi).

You can also try `orbit-components` live on [CodeSandbox](https://codesandbox.io/s/github/designkiwicom/orbit-sandbox).

## Types

Orbit comes with both Flow and Typescript definition files, so you can choose what fits your project.
If you're working with Typescript, you need to add a type for `styled-components`.

```shell
// with npm
npm install @types/styled-components --save-dev

// with yarn
yarn add @types/styled-components -D
```

## Contributing

We're working on making this project fully open-source.
We appreciate any contributions you might make.

[Bug reports](https://github.com/kiwicom/orbit/issues/new?template=bug_report.md)
and [feature requests](https://github.com/kiwicom/orbit/issues/new?template=feature_request.md) are welcome,
but please use the correct template.

Please check out our [contribution guide](https://github.com/kiwicom/orbit/tree/master/.github/CONTRIBUTING.md).
It includes contribution guidelines and information on how to run and develop the project.