---
name: 1. Welcome
route: /
order: 1
---

# Pointr Components

This page was created in order to keep all components well documented and to help new developers to start using Pointr Components.

## Technologies behind
- [ReactJS](https://github.com/facebook/react)
- [Styled Components](https://github.com/styled-components/styled-components)
- [Prop Types](https://github.com/facebook/prop-types)
- [Eslint](https://github.com/eslint/eslint)
- [Standard](https://github.com/standard/standard)
- [Jest](https://github.com/facebook/jest)
- [Enzyme](https://github.com/airbnb/enzyme)

## Running project locally

```javascript
git clone
yarn install
yarn docz
```

## Running tests

```javascript
yarn test
```

## Running lint

```javascript
yarn lint
```

## Setup as dependency in another project

```javascript
yarn add pointr-components
```

Import:

```javascript
import { Button } from 'pointr-components'
```

Use in your component:

```javascript
  ...

  render () {
    <Button>I am a button from Pointr</Button>
  }

  ...

```
