PorkChop.club

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

# 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, with a few changes.

# To see your violations run
$ npm run lint

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

Ruby

We use Rubocop to enforce the Relaxed.Ruby.Style guide, with a few changes.

# To see your violations run
$ bundle exec rubocop

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