Templatus (Inertia edition)

Templatus is an opinionated template to build web applications with Ruby on Rails and Inertia (using Svelte.js). It simplifies the process of setting up a new application while following best practices.

Features / Technology stack

Backend

• Ruby 3.2
• Ruby on Rails 7.1
• ActionCable for WebSocket communication
• PostgreSQL for using as SQL database
• Sidekiq for background processing
• Redis for Caching, ActionCable, and Sidekiq

Frontend

• Inertia as a protocol for frontend/backend communication
• Tailwind CSS 3 to not have to write CSS at all
• Tabler Icons for free SVG icons
• Vite for bundling JavaScript and CSS with Hot Module Replacement (HMR) in development

Development

• Puma-dev for using .test TLD (instead of localhost:3000) and https in development
• Overmind for starting up the application locally (Procfile handling like Foreman)
• dotenv to load environment variables from .env into ENV
• TypeScript for writing strongly-typed JavaScript
• Prettier for auto-formatting TypeScript and Ruby code in Visual Studio Code
• annotate for annotating models and routes

Linting and testing

• RuboCop for Ruby static code analysis
• RSpec for Ruby testing
• ESLint for TypeScript static code analysis
• Cypress for E2E testing

Deployment

• Docker for production deployment, NOT for development
• DockerRailsBase for fast building an optimized Docker image based on Alpine Linux
• GitHub Actions for testing, linting, and building Docker image
• Dependabot configuration for updating dependencies (with auto-merge)
• Ready for serving assets via CDN like CloudFront
• Honeybadger for error tracking in Ruby and TypeScript
• Plausible for privacy friendly analytics

Production

• Lograge for single-line logging
• Gzip compression of dynamic responses (HTML, JSON) using Rack::Deflater
• Fine-tuned Content Security Policy (CSP)

Metrics

This template is developed with optimized performance and security in mind. The following benchmarks are performed against the demo installation on production. It uses an inexpensive virtual server on the Hetzner Cloud behind a Traefik setup.

Lighthouse site performance

100% in all categories.

Security headers

What's the red Permissions-Policy badge? This seems to be fixed with one of the next Rails update: rails/rails#41994

Mozilla Observatory

WebPageTest

GTmetrix

Check-your-website

JavaScript size

176 KB of compiled JavaScript (after tree-shaking, minified & uncompressed).

$ RAILS_ENV=production bin/rails assets:precompile
yarn install v1.22.19
[1/6] 🔍  Validating package.json...
[2/6] 🔍  Resolving packages...
success Already up-to-date.
✨  Done in 0.11s.
Building with Vite ⚡️
vite v4.4.11 building for production...
transforming...
✓ 4980 modules transformed.
rendering chunks...
computing gzip size...
../../public/vite/manifest-assets.json               0.10 kB │ gzip:  0.09 kB
../../public/vite/assets/logo-10f03a2b.svg           0.50 kB │ gzip:  0.30 kB
../../public/vite/manifest.json                      0.57 kB │ gzip:  0.22 kB
../../public/vite/assets/application-e151bf91.css   21.46 kB │ gzip:  4.88 kB
../../public/vite/assets/application-eb9572d8.js    29.73 kB │ gzip: 11.17 kB │ map:  58.05 kB
../../public/vite/assets/vendor-597444d4.js        181.57 kB │ gzip: 61.41 kB │ map: 818.86 kB
✓ built in 21.26s
Build with Vite complete: /Users/ledermann/Projects/templatus-inertia/public/vite

Network transfer

Small footprint: The demo application transfers only 71 KB of data on the first visit.

Docker build time

With multi-stage building and using DockerRailsBase the build of the Docker image takes very little time. Currently, the deploy job requires about 1,5 minutes on GitHub Actions (see https://github.com/templatus/templatus-inertia/actions)

Docker image size

The Docker image is based on Alpine Linux and is optimized for minimal size (currently 115 MB uncompressed disk size). It includes just the bare minimum - no build tools like Node.js, no JS sources (just the compiled assets), no tests.

$ container-diff analyze ghcr.io/templatus/templatus-inertia -n

-----Size-----

Analysis for ghcr.io/templatus/templatus-inertia:
IMAGE                                 DIGEST     SIZE
ghcr.io/templatus/templatus-inertia   sha256:... 115M

Getting started

Install for development

1. Clone the repo locally:

git clone git@github.com:templatus/templatus-inertia.git
cd templatus-inertia

2. Install PostgreSQL, Redis, and puma-dev (if not already present). On a Mac with Homebrew, run this to install from the Brewfile:

brew bundle

3. Set up puma-dev to use HTTPS for development. Do this on macOS:

sudo puma-dev -setup
puma-dev -install
puma-dev link

# Use Vite via puma-dev proxy
# Adopted from https://github.com/puma/puma-dev#webpack-dev-server
echo 3036 > ~/.puma-dev/vite.templatus-inertia

4. Setup the application to install gems and NPM packages and create the database:

bin/setup

5. Start the application locally:

bin/dev

Replace all instances of rails-svelte-inertia-tinker with the directory that this project appears in Then open https://rails-svelte-inertia-tinker.test in your browser.

Running linters

RuboCop:

bin/rubocop

ESLint:

bin/yarn lint

TypeScript compiler:

bin/yarn tsc

Running tests locally

Ruby tests:

bin/rspec
open coverage/index.html

JavaScript unit tests:

bin/yarn test

E2E tests with Cypress:

bin/cypress open

This opens Cypress and starts Rails in development environment, but with CYPRESS=true, so the test database is used. This allows code editing without class reloading and recompiling assets.

To run Cypress in headless mode:

bin/cypress run

Test deployment locally

docker network create public
docker-compose up