bigbinary / wheel

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

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

First clone this repo.

Then install the Node.js version v18.12 which we have specified inside the .node-version file of this repo., using the following command:

nvm install

Make sure that yarn is installed with it as well in your system.

After yarn is installed, install the Node.js and Rails dependencies and also seed the database, by running:

./bin/setup

Start the server by executing following command.

bundle exec rails server -p 3000

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

Using docker for development

In BigBinary we follow the above mentioned style of installing dependencies using ./bin/setup and then running the servers manually. If that doesn't work in your system for some reason, then you can opt into following 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)

Features

• Uses Tailwind CSS.
• rake setup to set sensible sample data including user [email protected] with password welcome.
• Uses devise.
• 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.
• Letter opener gem for development.

neetoDeploy Review

neetoDeploy Review is enabled on this application. Thus all PRs will have a review app and once the PR is merged to main, it will be deployed to production instance. The neetoDeploy instance for Wheel is hosted in neeto-engineering organization.

About 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.

wheel's Issues

Add autoprefixer-rails for cross-browser css compatibilty

https://github.com/ai/autoprefixer-rails

this gem can avoid a lot of cross-browser CSS issues

Disable turbolinks gem

Update CSS structure

Just as we did in AceInvoice and BB website, we need to update CSS structure in wheel so new projects can follow the same organization.

Add browser livereload for views

While changing view files, live reload can automatically reload browser window. This can save lot of development time when working on frontend work.
refer: https://github.com/guard/guard-livereload

Upgrade to ruby 2.6.3

Update Ruby from 2.4.1 to 2.5.1 In Dockerfile

docker-compose up
throws this error
Step 6/6 : RUN bundle install ---> Running in 7f95f4e103d7 Warning: the running version of Bundler (1.15.4) is older than the version that created the lockfile (1.16.1). We suggest you upgrade to the latest version of Bundler by running gem install bundler. Your Ruby version is 2.4.1, but your Gemfile specified 2.5.1 ERROR: Service 'web' failed to build: The command '/bin/sh -c bundle install' returned a non-zero code: 18

Add Slim rails

https://github.com/slim-template/slim-rails

So that scaffold creates slim templates instead of erb

Environment configuration updates

Environment configuration updates.

• Update tagged logging
• Remove rails_12factor gem (heroku logging)
• Update sample database config
• Add sidekiq config

Upgrade Rails to fix the nightly build

https://app.circleci.com/pipelines/github/bigbinary/wheel/44/workflows/4caacc57-fe94-4de5-b2bb-e9d8d4295897/jobs/1765

@Hareramrai _a

Push to heroku should just work

As of now every push to heroku fails with ArgumentError: Missing required arguments: aws_access_key_id, aws_secret_access_key even when I'm not using aws.

Going to put some default value that could be changed later.

Remove deprecation warnings

https://monosnap.com/direct/baAgzZ7ZwEzQogvqav8CbMjnoEDpMz

https://circleci.com/gh/bigbinary/wheel/1391

@hari816 _a

Fix CI build

https://circleci.com/gh/bigbinary/wheel/1480

error /home/circleci/wheel/node_modules/node-sass: Command failed.
Exit code: 1

yarn install seems to be producing this error.

Idk when I'd be able to get to it. If anyone can pick it up please do.

Bump ruby to 2.6.5

Upgrade to Rails 5.2

Heroku asset precompile fails

remove .coffee files
refer: http://stackoverflow.com/a/36614358
https://github.com/bigbinary/wheel/blob/master/app/assets/javascripts/active_admin.js.coffee#L1

error for require in test_helper

I am facing the following error with the test_helper

LoadError: cannot load such file -- minitest/reporters

This happens for mocha/setup as well after I try commenting just the one require minitest/reporters line.

LoadError: cannot load such file -- mocha/setup

I have to comment all of them like this to make the tests run.

Replace honeybadger with rollbar

• change code
• updated README

Improve CircleCI perf

Ref: https://github.com/bigbinary/nitrohelp-web/issues/5443

Upgrade Rails to 6.0.3

https://weblog.rubyonrails.org/2020/5/6/Rails-6-0-3-has-been-released/

When we deploy to production then mark all honeybadger exceptions as resolved

Refer : 'https://github.com/bigbinary/caregeneral/pull/1198'

Modularize CSS

Switch from DelayedJob to sidekiq

Remove node_modules after assets:precompile

Heroku has a max slug size limit of 500MB. In order to help reduce the slug size, it would be good to remove node_modules folder after assets:precompile, before the slug is created.

argument list too long: perl

perl -e "s/Wheel/Pump/g;" -pi $(find . -type f) might thrown up an error

argument list too long: perl because the number of characters passed as an argument will be way more than ARG_MAX.

Might be a good to idea to only pass in the files which are added in git instead of all the files.

Also, this does not replace lower case characters in wheel.

Move JavaScript folder out of assets as is the case with Rails 6.0.2.1

Copy CSS from AceInvoice to Wheel

Step 1: Let's copy the common/base CSS files from AceInvoice app to wheel app and send a PR. No need to change anything else.

@nitinprojects _a

Upgrade to rails 5.1

Blocked by:

activeadmin/inherited_resources#433
collectiveidea/delayed_job_active_record#134
heartcombo/devise#4518

Add a test for autoloading in staging env in circle ci

This will prevent issues related to autoloading issues which are generally not caught in development.

Managing persistent data in docker

Because we execute bundle exec rake setup in the web container entrypoint, each time I execute docker-compose up, all the data is deleted and recreated.

We should check whether the database is already present and just run the migrations or did I miss something @vipulnsward @RahulMahale

Specifying gem version in Gemfile with twiddle-waka

I started one of demo project from wheel. As I have simple_form 1.4.1 and 3.1.0 both present on machine, running bundle choose to go with 1.4.1 version of simple_form.

App fails to boot because it depends on 3.1.0 APIs of gem.

So, can we have versions specified for all the gems that we have in Gemfile and also make sure we have this as style guideline. I wrote something about it long back here - http://rtdptech.com/2011/09/specifying-gem-versions-in-gemfile-for-rails-application/

Change default ids to uuid

https://blog.bigbinary.com/2016/04/04/rails-5-provides-application-config-to-use-uuid-as-primary-key

Since all our projects inherit wheel, this is becoming a chore. We should not use plain ids anymore in projects.

Upgrade Rails version to Rails 6

Update libraries

Nightly builds?

@neerajdotname Can we revert the commit which disabled nightly builds?

The reason for setting up nightly builds in the first place was to discover CVEs and fix them which would otherwise go unnoticed.
Some examples of commits which were pushed because of these nightly builds:
c6a8165
a09a1b8
31a5f92
11cc604

The current build takes ~1:30 minutes to complete which I think we can spare every day for this purpose.

Let me know what you think.

precommit hook dependencies installation documentation

yarn install is not specified in docs and there is no script to install
ruby and node dependencies

Enable Dependabot to perform security (gem) updates

Why?
Let machines do what they can.

Context:
A nokogiri CVE was recently discovered/reported which is why the CI build on master failed.
On a client project, we had Dependabot enabled and it automatically created a PR to upgrade the gem. I only had to merge it after the tests passed.

Use thin in development mode

• to cut down the noise

Remove all traces of docker from this repo

At BigBinary we are not using it. We do not even know if it works or not.

Please remove all code related to docker and please also update README.

@Rohann7 _a

Dockerized wheel

Superadmin CSS layout not working

Settings doesn't reload

We do a custom loading of settings from handy. Since we have added spring, the background process doesn't seem to reload settings leading to old settings still getting served during development.

Remove minitest-reporters

Ref https://github.com/bigbinary/aceinvoice-web/pull/2129/files

Upgrade serialize-javascript to version 2.1.1 or later.

https://github.com/bigbinary/wheel/network/alert/yarn.lock/serialize-javascript/closed
Run yarn upgrade to update packages to latest version

Rails upgrade - 6.0.0 to 6.0.2.1

Rails upgrade - 6.0.0 to 6.0.2.1

edit password view error

I was getting an error on the /app/views/users/passwords/edit.html.slim page.

I had to remove the trailing slashes on line 14 and 18 and it worked:
https://github.com/bigbinary/wheel/blob/master/app/views/users/passwords/edit.html.slim#L18

Use Rails template

Rails added http://guides.rubyonrails.org/rails_application_templates.html to help build things are like wheel. We should be using it.

@kalamkar _a When you are on bench then start working on it.

Add SetCurrentRequestDetails

As per https://www.youtube.com/watch?v=D7zUOtlpUPw let's add SetCurrentRequestDetails

In SetCurrentRequestDetails add a link to this video for reference.

Default to Sidekiq

We use it in mostly all of our projects over DJ. We should default to what we actually use.
It also have doesn't have a hard deployment strategy for Heroku, etc.

https://github.com/mperham/sidekiq/wiki/Deployment

Prevent committing when "console.log" is detected in a modified JS file

An ESLint rule "no-console": 2 inside .eslintrc manifest should detect usage of console.*
when the ES linter is run using a pre-commit hook.

I assume that this should work with Prettier which we use in this repository.

Upgrade to Circle 2.0