Hyperloop 🚄

Speed up your new Rails 7.1 projects with a preconfigured set of tools !

Note

This template has been built to match as best as possible default changes I make on every new Rails project I work on. It is very opinionated for some configuration so feel free to fork it and adapt it according to your needs.

Usage

If you don't have yet the project cloned, fetch it from remote URL:

$ rails new myapp -m https://raw.githubusercontent.com/anthony-robin/hyperloop/master/template.rb

If you already cloned it:

$ rails new myapp -m hyperloop/template.rb

Wait for the end of the installer, then start it with:

$ bin/dev

Tools

Gems

In production:

• sqlite3 adapter by default and pg available with a quick change in database.yml
• turbo-rails and stimulus-rails for javascript related features
• slim-rails for views templates
• tailwindcss-rails as frontend framework
• solid_queue as production job adapter
• sorcery as authentication
• simple_form for handling forms inputs
• pagy for pagination
• meta-tags for SEO friendly
• action_policy as authorization actions verifier
• dotenv-rails to handle .env files
• activestorage and actiontext available by default
• ffaker to generate fake data (seed database)

In development:

• annotate to print model database structure (opinionated configuration)
• brakeman to check for security vulnerability in code
• bullet to track N+1 queries
• chusaku to print routes URL above controller actions
• letter_opener to intercept emails and print them in browser
• ruby-lsp-rails to have better rails integration into editor
• rubocop and its extensions for coding conventions (very opinionated)
• ribbonit to display Ruby and Rails informations
• ruby-lsp-rails to improve rich features in editors
• hotwire-livereload to reload browser page on save

Frontend

• TailwindCSS
• Flowbite for responsive navbar and sidebar

Features

• Sorcery comes with session, registration and reset password features preconfigured as well as related mailers.

• SEO is preconfigured to work in any pages by default and title/description can be specified directly in seo.{locale}.yml file.

• Default browser confirm modal as been replaced with a pretty and friendly one following excellent gorails tutorial

• Database is seed with default users corresponding to each access level

• If using postgres adapter, database can be dockerized using:

  $ docker-compose up -d

• Project is configured for french and english locales

Roadmap

See Github project for coming roadmap.

Credits

Hyperloop is inspired by:

• projects developed for La Voix du Chat Artiste
• excid3/jumpstart for its starter template
• bdavidxyz/tailstart for its starter instructions

Thank you :)