https://github.com/bshyman/shankshack

A golf tracker for the boys
https://github.com/bshyman/shankshack

Last synced: 2 days ago
JSON representation

A golf tracker for the boys

• Host: GitHub
• URL: https://github.com/bshyman/shankshack
• Owner: bshyman
• Created: 2021-03-19T04:05:40.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-27T02:50:52.000Z (almost 4 years ago)
• Last Synced: 2025-01-11T15:57:46.151Z (9 days ago)
• Language: Ruby
• Size: 274 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Schnorrcard

Ruby on Rails application initialized with [Hix on Rails][hixonrails].

## System dependencies

- Ruby version: 2.7.0

- Rails version: 6.1.3

- Database: PostgreSQL

- Redis installed

## Configuration

Copy an existing sample environment file. Run:

```bash

$ cp .env.sample .env

```

and edit newly created `.env` file. The minimum you are going to need are

credentials to your local PostgreSQL database.

Then, install all the necessary gems:

```bash

bundle install

```

## Database creation

In order to create the database with all the necessary seed data, run:

```bash

$ rails db:create db:schema:load db:seed

```

## How to start the app

Start the Ruby on Rails server with:

```bash

rails server

```

To run Sidekiq, launch another process with:

```bash

bundle exec sidekiq

```

## Code quality checks

The application provides the following code quality analysis tools:

- [RuboCop][rubocop] with [RuboCop Performance][rubocop-performance] and [RuboCop Rails][rubocop-rails]

To run them locally:

```bash

$ bundle exec rubocop

```

[hixonrails]: https://hixonrails.com

[rubocop]: https://github.com/rubocop-hq/rubocop

[rubocop-performance]: https://github.com/rubocop-hq/rubocop-performance

[rubocop-rails]: https://github.com/rubocop-hq/rubocop-rails