hp-redux/README.md

Hearthstone simulator

# hp-redux 
[![Build Status](https://travis-ci.org/Bebersohl/hp-redux.svg?branch=master)](https://travis-ci.org/Bebersohl/hp-redux)
[![Coverage Status](https://coveralls.io/repos/Bebersohl/hp-redux/badge.svg?branch=master)](https://coveralls.io/r/Bebersohl/hp-redux?branch=master)

hp-redux is a Hearthstone simulator.

## Getting Started
If you are not familiar with Redux these are good resources:
* https://egghead.io/courses/getting-started-with-redux (first 16 videos)
* http://redux.js.org/

Read the [wiki](https://github.com/Bebersohl/hp-redux/wiki) to understand the scope of the project.

Read [CONTRIBUTING.md](https://github.com/Bebersohl/hp-redux/blob/master/CONTRIBUTING.md) before submitting a pull request.

### Prerequisites

Node.js, which can be installed [here](https://nodejs.org/en/) (get the current version)

### Installing

Clone the repo.

```
git clone https://github.com/Bebersohl/hp-redux
```

Navigate to your repo.

```
cd hp-redux
```

Install the dependencies.

```
npm install
```

Now that the project is set up you can run index.js to test your code.

```
node src/index
```

## Running the tests

```
npm test
```

### And coding style tests

We are using eslint and [Airbnb's style guide](https://github.com/airbnb/javascript)

```
npm run lint
```

## Contributing

Please read [CONTRIBUTING.md](https://github.com/Bebersohl/hp-redux/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Authors

* **Brandon Ebersohl** - *Initial work* - [bebersohl](https://github.com/bebersohl)

See also the list of [contributors](https://github.com/Bebersohl/hp-redux/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

Borrowed heavily from [hearthbreaker](https://github.com/danielyule/hearthbreaker/wiki)