porkchopclub/porkchop

# PorkChop.club [![Build Status](https://travis-ci.org/PorkChopClub/porkchop.svg?branch=master)](https://travis-ci.org/porkchopclub/porkchop) [![Code Climate](https://codeclimate.com/github/porkchopclub/porkchop/badges/gpa.svg)](https://codeclimate.com/github/porkchopclub/porkchop) [![Test Coverage](https://codeclimate.com/github/porkchopclub/porkchop/badges/coverage.svg)](https://codeclimate.com/github/porkchopclub/porkchop/coverage)

A ping pong scoreboard and stat-tracking application.

## Development

### Requirements
* a reasonable version on NodeJS
* whatever Ruby version is specified in the `Gemfile`
* PostgreSQL database
* Redis server (on an Ubuntu system, all you need to do is `sudo apt-get install redis-server`)
* Yarn dependency manager (if you already have NodeJS you just need to `npm install --global yarn`)

### Setup

```shell
# Run these to these to get the project setup:
$ ./bin/setup

# For development run these simultaneously:
$ bundle exec rails s -p 2277
$ bundle exec sidekiq
$ npm run watch

# If you want to use LiveReload, also run:
$ bundle exec guard
```

## Style Guides

### JavaScript

This project inherits from [Airbnb's JavaScript Style Guide](https://github.com/airbnb/javascript), with a few changes.

```shell
# To see your violations run
$ npm run lint

# To fix any that can be automatically fixed
$ npm run autofix
```

### Ruby

We use [Rubocop](https://github.com/bbatsov/rubocop) to enforce the [Relaxed.Ruby.Style](http://relaxed.ruby.style/) guide, with a few changes.

```shell
# To see your violations run
$ bundle exec rubocop

# To fix any that can be automatically fixed
$ bundle exec rubocop -a

```