Skip to content
/ shore Public

Modern Ruby on Rails template to start every new project. Skip the boilerplate and focus on what's unique to your project.

Notifications You must be signed in to change notification settings

yatish27/shore

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4dff6e4 · Apr 20, 2024

History

35 Commits
Apr 19, 2024
Apr 19, 2024
Apr 20, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 20, 2024
Apr 20, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024
Apr 19, 2024

Repository files navigation

Shore

This is a Rails 7.1 app.

Prerequisites

This project requires:

  • Ruby (see .ruby-version), preferably managed using rbenv
  • Node 18 (LTS) or newer
  • Yarn 1.x (classic)
  • PostgreSQL must be installed and accepting connections

On macOS, these Homebrew packages are recommended:

brew install rbenv
brew install node
brew install yarn
brew install postgresql@16

Getting started

bin/setup

Run this script to install necessary dependencies and prepare the Rails app to be started for the first time.

bin/setup

Tip

The bin/setup script is idempotent and is designed to be run often. You should run it every time you pull code that introduces new dependencies or makes other significant changes to the project.

Run the app!

Start the Rails server with this command:

yarn start

The app will be located at http://localhost:3000/.

Development

Use this command to run the full suite of automated tests and lint checks:

bin/rake

Tip

Rake allows you to run all checks in parallel with the -m option. This is much faster, but since the output is interleaved, it may be harder to read.

bin/rake -m

Fixing lint issues

Some lint issues can be auto-corrected. To fix them, run:

bin/rake fix

Warning

A small number of Rubocop's auto-corrections are considered "unsafe" and may occasionally produce incorrect results. After running fix, you should review the changes and make sure the code still works as intended.