![Nachos UI](https://cldup.com/xHYkAezOnI.jpg)

[![Build Status](https://api.travis-ci.org/avocode/nachos-ui.svg?branch=master)](https://travis-ci.org/avocode/nachos-ui)

## Intro

Nachos UI is a React Native component library. [Read more](https://medium.com/avocode-stories/my-experience-of-building-nachos-ui-kit-for-react-native-c8307500b8a4#.sh5cvk242) about how we built it on Medium.

### Features:

- Over 30 UI components
- Customizable UI components
- Works on **Web** thanks to [React Native for Web](https://github.com/necolas/react-native-web)
- Jest [Snapshot Testing](http://facebook.github.io/jest/docs/snapshot-testing.html)
- Uses [Prettier](https://github.com/jlongster/prettier) an opinionated JavaScript formatter.
- Uses [Yarn](https://yarnpkg.com/)


## Getting started

> **Requires React Native 0.40 and higher.**

```
$ npm install --save nachos-ui  
```

OR

```
$ yarn add nachos-ui
```

```jsx
import React from 'react'
import { View } from 'react-native'
import { Button } from 'nachos-ui'

const App = () => {
  return (
    <View>
    	<Button>Button</Button>
    </View>
  )
}
```


## Documentation


Visit the documentation at https://avocode.com/nachos-ui/docs/ with technical information about each component.


## Contributing

**Contributions are always welcome!** Before contributing, please read our [Code Of Conduct](https://github.com/avocode/nachos-ui/blob/master/CODE_OF_CONDUCT.md).

Read [Contributing](https://github.com/avocode/nachos-ui/blob/master/CONTRIBUTING.md).


## Developers

To play with Nachos UI locally first clone the repository:

```
$ git clone git@github.com:avocode/nachos-ui.git
```

Ideally use Yarn to install your dependencies. It's fast and consistent:

```
$ yarn install
```

To run the iOS simulator run:

```
$ yarn run start
```

To run the Web version:

```
$ yarn run start:web
```


## License

Nachos UI is open source and released under the [MIT License](https://github.com/avocode/nachos-ui/blob/master/LICENSE).

## Thanks!

- [Vacuumlabs](https://vacuumlabs.com/)
- [Polgár András](https://github.com/azazdeaz)
- [Oliver Drahota](https://github.com/csidro)