matthewlafalce / kickstart

:zap: Opinionated Rails 7 Template

Kickstart Rails Template

All your Rails apps should start off with a bunch of great defaults.

Getting Started

Kickstart is a Rails template, so you pass it in as an option when creating a new app.

Requirements

You'll need the following installed to run the template successfully:

• Ruby 3.0 or higher
• bundler - gem install bundler
• rails - gem install rails
• Database - we recommend Postgres, but you can use MySQL, SQLite3, etc
• Redis - For ActionCable support
• Yarn - brew install yarn or Install Yarn
• Foreman (optional) - gem install foreman - helps run all your processes in development

Features

• Development

  • annotate - Annotate Rails classes with schema and routes info.
  • awesome_print - Pretty print your Ruby objects with style in full color and with proper indentation.
  • faker - A library for generating fake data such as names, addresses, and phone numbers.
  • Comming Soon letter_opener_web - A web interface for browsing Ruby on Rails sent emails.

• Security

  • Comming Soon brakeman - Detects security vulnerabilities in Ruby on Rails applications via static analysis.
  • Comming Soon bundler-audi - Provides patch-level verification for Bundled apps.

• Authentication/Administration

  • Comming Soon avo - Configuration-based, no-maintenance, extendable Ruby on Rails admin.
  • Comming Soon devise - Flexible authentication solution for Rails with Warden.
  • Comming Soon pretender - Log in as another user in Rails.
  • Comming Soon pundit - Object oriented authorization for Rails applications.

• Job Processing

  • Comming Soon good_job - A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails

• Other

  • Comming Soon friendly_id - Create pretty URLs and work with human-friendly strings as if they were numeric ids.
  • Comming Soon name_of_person - Presenting names of people in full, familiar, abbreviated, and initialized forms (but without titulation etc)
  • Comming Soon sitemap_generator - SitemapGenerator is a framework-agnostic XML Sitemap generator.
  • Comming Soon inline_svg - Get an SVG into your view and then style it with CSS.
  • Comming Soon responders - A set of Rails responders to dry up your application.

Creating a new app

rails new myapp --database=postgresql --css=tailwind --skip-bundle --skip-test -m https://raw.githubusercontent.com/MatthewLaFalce/kickstart/main/template.rb

Or if you have downloaded this repo, you can reference template.rb locally:

rails new myapp --database=postgresql --css=tailwind --skip-bundle --skip-test -m template.rb

❓Having trouble? Try adding DISABLE_SPRING=1 before rails new. Spring will get confused if you create an app with the same name twice.

Running your app

bin/dev

You can also run them in separate terminals manually if you prefer.

A separate Procfile is generated for deploying to production on Heroku.

Redis set up

On OSX

brew update
brew install redis
brew services start redis

Ubuntu

sudo apt-get install redis-server

Cleaning up

rails db:drop
spring stop
cd ..
rm -rf myapp