GitHunt
RT

rthbound/wheel

Don't reinvent the wheel for every new Rails project. Use sane Defaults.

Circle CI

TOC

About

This is a base project to quickly spin up a
Rails application which is built with
opinions of BigBinary team.

Local Development Setup

bundle install
cp config/database.yml.postgresqlapp config/database.yml
rake setup
bundle exec rails server

Running with Docker

Pre-Requesites

Make sure you have docker and docker-compose installed.

Starting rails

docker-compose up

After the container is successfully created you should be able to access your app on http://localhost:9000

Replace Wheel with your project name

Let's say that the project name is Pump. Execute the command below to
replace all occurrences of Wheel with Pump.

perl -e "s/Wheel/Pump/g;" -pi $(find . -type f)

Features

  • Uses Bootstrap .
  • rake setup to set sensible sample data including user sam@example.com with password welcome.
  • Uses devise .
  • Heroku ready. Push to heroku and it will work .
  • Uses Honeybadger.
  • Built in superadmin feature.
  • Uses modal box to showcase an example of editing information using modal box.
  • Enables strict mode for all JavaScript code.
  • Uses puma as web server.
  • Uses haml for cleaner syntax over erb.
  • No coffeescript. We prefer JavaScript.
  • Uses turbolinks.
  • Uses ActiveAdmin.
  • When exception is sent to Rollbar then uuid is also sent for debugging .
  • Uses DelayedJob.
  • Intercepts all outgoing emails in non production environment using gem mail_interceptor.
  • Uses CircleCI for continuous testing.
  • Has a bunch of tests to make it easier to get started with new tests.
  • Uses PostgreSQL.
  • Built in support for carrierwave to easily upload items to s3.
  • Built in support for "variants" so the pages can be customized for tablet or phone easily.
  • Uses simple_form.
  • Built in support for Mailgun.
  • Easy to generate "test coverage".
  • Content compression via Rack::Deflater.

Heroku Review

Heroku Review
is enabled on this application. It means when a PR is sent then heroku
automatically deploys an application for that branch.

Brought to you by

Languages

Ruby78.0%HTML18.5%JavaScript1.8%CSS1.6%Shell0.1%CoffeeScript0.0%
Created July 20, 2017
Updated March 5, 2023