https://github.com/PorkChopClub/porkchop

Ping Pong tracking!
https://github.com/PorkChopClub/porkchop

bacon ping-pong rails react ruby table-tennis

Last synced: about 1 month ago
JSON representation

Ping Pong tracking!

• Host: GitHub
• URL: https://github.com/PorkChopClub/porkchop
• Owner: PorkChopClub
• License: other
• Created: 2015-02-27T22:34:01.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-06-18T17:47:02.000Z (over 6 years ago)
• Last Synced: 2024-08-05T08:07:52.169Z (5 months ago)
• Topics: bacon, ping-pong, rails, react, ruby, table-tennis
• Language: Ruby
• Homepage: https://porkchop.club
• Size: 3.23 MB
• Stars: 4
• Watchers: 9
• Forks: 3
• Open Issues: 10
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

• Open-Source-Ruby-and-Rails-Apps - PorkChop - A ping pong scoreboard and stat-tracking application. 🔥 (Happy Exploring 🤘)

README

        
# 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

```