README.md

Railsboost

An opinionated template to boost your bootstrapping productivity. Railsboost is an expanded version of Jumpstart, incorporating even more great defaults!

Gems

Gems included from the start with Railsboost:

• Background processing via sidekiq
• Cron jobs via whenever
• SEO meta-tags and sitemap generator via meta-tags & sitemap_generator
• Collect user information with simple_form
• Pretty JSON output for your API with active_model_serializers
• Turbolinks support
• Authentication via devise
• Easily configurable admin dashboards uisng administrate
• Convenient wrapper for your ENV with nenv
• Use hashids for your models with hashid-rails
• Maintain good standards with rubocop & strong_migrations & rails-patterns
• Inspect your emails via letter_opener_web
• Debug with better_errors

TailwindCSS

Use utility-first CSS to style your application using TailwindCSS. It comes with several great defaults:

• Form styling with custom-forms
• Background shapes with tailwind-heropatterns
• Sample primary/secondary/success/warning/danger colours, which you can easily customise
• Alert, buttons, tabs, default typography, cards and more components

StimulusJS

Add Javascript to your HTML in a structured way using StimulusJS. Railsboost comes with several useful controllers which work out of the box:

• modal controller
• tabs controller
• dropdown controller
• nested form controller
• toggle controller
• clipboard controller

Other goodies

• Active Storage using Uppy and S3 (include your S3 environment variables in your .env file)
• All Feather icons are included in the project by default - use them easily with the render_icon helper
• Action Text & Trix included by default

Installation

1. Clone the repo - git clone https://github.com/kb1995/railsboost.git your_app_name
2. gem install bundle && bundle install
3. yarn install
4. gem install foreman
5. replace "railsboost_" in config/database.yml && "Railsboost" in config/application.rb with your new app name
6. rails db:setup & rake db:migrate
7. run your server using foreman s

You can use .env.example as a base for your .env file

Reset your .git

1. rm -rf .git
2. git init
3. git add .
4. git commit -m 'First commit'
5. push to your remote repo

Happy coding 🚀