Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.95 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.95 KB
Raw

Build Status

Made by the team at BigBinary, this is a base project to quickly spin up a Rails application built with opinions of BigBinary style of working.

Local Development Setup

Clone this repo by running git clone https://github.com/bigbinary/wheel.git.

Install the Node.js version v16.5 which we have specified inside the .node-version file.

nvm install

Make sure that yarn is installed with it as well.

./bin/setup

Start the server by executing following command.

bundle exec rails server

Visit http://localhost:3000 and login with email [email protected] and password welcome.

Using docker for development

Follow the instructions mentioned here to use docker for development.

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 -pi -w -e 's/Wheel/Pump/g;' $(git ls-files)
perl -pi -w -e 's/wheel/Pump/g;' $(git ls-files)

Features

  • Uses Tailwind CSS.
  • rake setup to set sensible sample data including user [email protected] with password welcome.
  • Uses devise.
  • Heroku ready. Push to Heroku and it will work.
  • Uses Honeybadger.
  • Uses slim for cleaner syntax over erb and better performance over haml.
  • Uses ActiveAdmin.
  • Uses Sidekiq.
  • Intercepts all outgoing emails in non production environment using gem mail_interceptor.
  • Uses SemaphoreCI for continuous testing.
  • Uses PostgreSQL.
  • Content compression via Rack::Deflater.
  • Auto-formats Ruby code with rubocop.
  • Auto-formats JavaScript and CSS code with prettier.
  • Performs background job processing "inline" for heroku env. It means heroku can deliver emails.
  • Letter opener gem for development.

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.

About BigBinary

BigBinary

wheel is maintained by BigBinary. BigBinary is a software consultancy company. We build web and mobile applications using Ruby on Rails, React.js, React Native and Node.js.