Skip to content
/ RailsBooster Public template

⚡️ Ruby On Rails Boilerplate For Instant Productivity

License

Notifications You must be signed in to change notification settings

BilalBudhani/RailsBooster

Repository files navigation

🚀 RailsBooster

Pre-Configured Ruby On Rails Boilerplate To Provide Instant Productivity ⚡️

🤓 Motivation behind the project

I regularly keep experimenting with ideas and problems to solve with Ruby On Rails as my choice of stack. However, I find myself configuring Rails as per my preference with every new project to reach to a stage where I can start working on the actual business logic.

RailsBooster is an attempt to put together all the common configurations, gems and best practices in one place which will eliminate the need of all prerequisites and immediately enables working on the actual business logic.

📦 What's in the box?

  • I prefer using Vue and Inertia instead of Turbolinks.
  • Authentication using Devise with pretty Login/Sign Up pages
  • TailwindCSS as CSS framework with PurgeCSS configured
  • DotEnv support for picking up variables from .env only for development & testing environment
  • SuckerPunch for running lightweight async background jobs as ActiveJob default adapter
  • Uses Standard as Ruby linter
  • View outgoing emails at /letters in development
  • Model annotations to ease decision making

🛠 How to use

  • Clone this repo with git clone git@github.com:BilalBudhani/RailsBooster.git [YOUR PROJECT FOLDER NAME]
  • Run bundle install && yarn install
  • Run cp .env.example .env
  • Use your IDE's find & replace functionality to rename RailsBooster to [ProjectName]
  • RailsBooster ships with Procfile.dev to run multiple processes with a single command. I recommend installing Overmind or Foreman to run this project.
  • Start Rails and Webpacker server with overmind s

👀 Roadmap

  • Basic authentication
  • Configure TailwindCSS to provide basic styling
  • Use production ready backgrounding gem for async usage
  • Setup a linter for keeping styleguide & formatting in check
  • Template for mailer views
  • Sign in via Google authentication
  • Move to clearance for simpler authentication abstraction
  • ActionCable support
  • ActiveStorage support
  • Github actions to enforce linters

License

RailsBooster is licensed under the MIT license. (opensource.org/licenses/MIT)

About

⚡️ Ruby On Rails Boilerplate For Instant Productivity

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 2

  •  
  •