README.md

WIP: Rails Shotgun

Ruby on Rails application initialized with all the good stuff. Use at your own risk or we welcome pull requests. I will be working on a roadmap soon.

Why is it named Shotgun??

Shotgunning a beer is the simple act of consuming a beer at a high rate of speed.

The inspiration came from one of my common college activities. Rails Shotgun lets you be as productive as shotgunning a beer is at getting you drunk.

Setup

Please take note that we are using main as the base branch.

System dependencies

• Ruby version: 2.7.1
• Rails version: 6.0.3.2
• Database: PostgreSQL
• Redis installed

Rename Application

You will want to rename the application first. Here are some options:

• Watch the CodeTour
• Find and replace CHANGEME throughout. Note that if you take this method, you need to be aware of using the correct case.

Configuration

Make sure the app has been renamed before doing these steps.

Automated

bin/setup

Manually

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 dependencies:

bundle install && yarn install

Database creation

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

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

How to start the app

Start the Ruby on Rails server with:

rails server

We highly recommend running the weback dev server in another tab instead of inline compilation that will occur if you don't for speed.

bin/webpack-dev-server

To optionally run Sidekiq, launch another process with:

bundle exec sidekiq

Code quality checks

The application provides the following code quality analysis tools:

• Brakeman
• Fasterer
• Rails Best Practices
• Bundler Audit

To run them locally:

$ bundle exec brakeman
$ bundle exec fasterer
$ bundle exec rails_best_practices
$ bundle audit

Removed Gems

• redis-namespace
  • Not needed and it was throwing a bunch of warnings.
• active-record-observer
  • Unused
• activeresource
  • Unused
• ngrok-tunnel
  • Not needed if using tmuxinator
• better_errors
  • Not really needed anymore now that Rails has made some improvements that made this a real nice-to-have

Changelog

Coming Soon

Contributing

Contributing Guide

Code of Conduct

Code of Conduct

License

MIT

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Andrew Mason 💻 🤔 🚇 🚧 👀 💬

cjilbert504 💻 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!