Repository files navigation

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

First clone this repo.

Then install theNode.js versionv16.5 which we have specified inside the.node-version file of this repo.

nvm install

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

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

bundleexec rails server -p 3000

Visithttp://localhost:3000 and login with emailoliver@example.com and passwordwelcome.

Follow the instructions mentionedhere to use docker for development.

Let's say that the project name isPump. Execute the command below toreplace all occurrences ofWheel withPump.

perl -pi -w -e's/Wheel/Pump/g;'$(git ls-files)perl -pi -w -e's/wheel/Pump/g;'$(git ls-files)

• UsesTailwind CSS.
• rake setup to set sensible sample data including useroliver@example.com with passwordwelcome.
• Usesdevise.
• Heroku ready. Push to Heroku and it will work.
• UsesHoneybadger.
• Uses slim for cleaner syntax over erb and better performance over haml.
• UsesActiveAdmin.
• UsesSidekiq.
• Intercepts all outgoing emails in non production environment using gemmail_interceptor.
• UsesSemaphoreCI for continuous testing.
• Uses PostgreSQL.
• Content compression viaRack::Deflater.
• Auto-formats Ruby code withrubocop.
• Auto-formats JavaScript and CSS code withprettier.
• Performs background job processing "inline" for heroku env. It means heroku can deliver emails.
• Letter opener gem for development.

Heroku Reviewis enabled on this application. It means when a PR is sent then Herokuautomatically deploys an application for that branch.

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