Port Laravel Starter Kit

Author: skryukov

.github/workflows/ci.yml

@@ -6,6 +6,31 @@ on:
     branches: [main]
 
 jobs:
+
+  lint_js:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Check prettier formatting
+        run: npm run format
+
+      - name: Check for linting errors
+        run: npm run lint
+
+      - name: Check type errors
+        run: npm run check
+
   scan_ruby:
     runs-on: ubuntu-latest
 

.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Deploy
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    branches: [main]
+    types:
+      - completed
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: false # deploy is disabled by default
+    # uncomment to enable:
+    # if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    timeout-minutes: 20
+    env:
+      DOCKER_BUILDKIT: 1
+      BUNDLE_ONLY: deploy
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Setup SSH
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+
+      - name: Deploy
+        env:
+          VERSION: ${{ github.sha }}
+          KAMAL_REGISTRY_PASSWORD: ${{ secrets.KAMAL_REGISTRY_PASSWORD }}
+          RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+        run: bundle exec kamal deploy --version=$VERSION

Gemfile

@@ -69,6 +69,9 @@ end
 group :development do
   # Use console on exceptions pages [https://github.com/rails/web-console]
   gem "web-console"
+
+  # Use letter_opener to preview emails in the browser in development [https://github.com/ryanb/letter_opener]
+  gem "letter_opener"
 end
 
 group :test do

Gemfile.lock

@@ -96,6 +96,8 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
+    childprocess (5.1.0)
+      logger (~> 1.5)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.3)
     crass (1.0.6)
@@ -150,6 +152,12 @@ GEM
       thor (~> 1.3)
       zeitwerk (>= 2.6.18, < 3.0)
     language_server-protocol (3.17.0.5)
+    launchy (3.1.1)
+      addressable (~> 2.8)
+      childprocess (~> 5.0)
+      logger (~> 1.6)
+    letter_opener (1.10.0)
+      launchy (>= 2.2, < 4)
     lint_roller (1.1.0)
     logger (1.7.0)
     loofah (2.24.1)
@@ -409,6 +417,7 @@ DEPENDENCIES
   jbuilder
   js-routes
   kamal
+  letter_opener
   propshaft
   puma (>= 5.0)
   rails (~> 8.0.2)

Procfile.dev

@@ -1,3 +1,3 @@
 
 vite: bin/vite dev
-web: bin/rails s
+web: bin/rails s -p 3000

README.md

@@ -1,24 +1,73 @@
-# README
+# Inertia Rails Vue Starter Kit
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+A modern full-stack starter application with Rails backend and Vue.js frontend using Inertia.js based on the [Laravel Starter Kit](https://github.com/laravel/vue-starter-kit).
 
-Things you may want to cover:
+## Features
 
-* Ruby version
+- [Inertia Rails](https://inertia-rails.dev) & [Vite Rails](https://vite-ruby.netlify.app) setup
+- [Vue.js](https://vuejs.org) frontend with TypeScript & [shadcn/vue](https://shadcn-vue.com) component library
+- User authentication system (based on [Authentication Zero](https://github.com/lazaronixon/authentication-zero))
+- [Kamal](https://kamal-deploy.org/) for deployment
+- Optional SSR support
 
-* System dependencies
+See also:
+- [React Starter Kit](https://github.com/inertia-rails/react-starter-kit) for Inertia Rails with React
 
-* Configuration
+<a href="https://evilmartians.com/?utm_source=inertia-rails-vue-starter-kit&utm_campaign=project_page">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Built by Evil Martians" width="236" height="54">
+</a>
 
-* Database creation
+## Setup
 
-* Database initialization
+1. Clone this repository
+2. Setup dependencies & run the server:
+   ```bash
+   bin/setup
+   ```
+3. Open http://localhost:3000
 
-* How to run the test suite
+## Enabling SSR
 
-* Services (job queues, cache servers, search engines, etc.)
+This starter kit comes with optional SSR support. To enable it, follow these steps:
 
-* Deployment instructions
+1. Open `app/frontend/entrypoints/inertia.ts` and uncomment part of the `setup` function:
+   ```ts
+    // Uncomment the following to enable SSR hydration:
+    // if (el.hasChildNodes()) {
+    //   createSSRApp({ render: () => h(App, props) })
+    //     .use(plugin)
+    //     .mount(el)
+    //   return
+    // }
+   ```
+2. Open `config/deploy.yml` and uncomment several lines:
+   ```yml
+   servers:
+     # Uncomment to enable SSR:
+     # vite_ssr:
+     #   hosts:
+     #     - 192.168.0.1
+     #   cmd: bundle exec vite ssr
+     #   options:
+     #     network-alias: vite_ssr
+      
+   # ...
+      
+   env:
+     clear:
+       # Uncomment to enable SSR:
+       # INERTIA_SSR_ENABLED: true
+       # INERTIA_SSR_URL: "http://vite_ssr:13714"
+      
+   # ...
+      
+   builder:
+     # Uncomment to enable SSR:
+     # dockerfile: Dockerfile-ssr
+   ```
 
-* ...
+That's it! Now you can deploy your app with SSR support.
+
+## License
+
+The project is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

app/controllers/application_controller.rb

@@ -1,21 +1,33 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has.
   allow_browser versions: :modern
 
+  inertia_share flash: -> { flash.to_hash }
+
   before_action :set_current_request_details
   before_action :authenticate
 
   private
-    def authenticate
-      if session_record = Session.find_by_id(cookies.signed[:session_token])
-        Current.session = session_record
-      else
-        redirect_to sign_in_path
-      end
-    end
-
-    def set_current_request_details
-      Current.user_agent = request.user_agent
-      Current.ip_address = request.ip
-    end
+
+  def authenticate
+    redirect_to sign_in_path unless perform_authentication
+  end
+
+  def require_no_authentication
+    return unless perform_authentication
+
+    flash[:notice] = "You are already signed in"
+    redirect_to root_path
+  end
+
+  def perform_authentication
+    Current.session ||= Session.find_by_id(cookies.signed[:session_token])
+  end
+
+  def set_current_request_details
+    Current.user_agent = request.user_agent
+    Current.ip_address = request.ip
+  end
 end

app/controllers/dashboard_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class DashboardController < InertiaController
+  def index
+  end
+end

app/controllers/home_controller.rb

@@ -1,4 +1,9 @@
-class HomeController < ApplicationController
+# frozen_string_literal: true
+
+class HomeController < InertiaController
+  skip_before_action :authenticate
+  before_action :perform_authentication
+
   def index
   end
 end

app/controllers/identity/email_verifications_controller.rb

@@ -1,4 +1,6 @@
-class Identity::EmailVerificationsController < ApplicationController
+# frozen_string_literal: true
+
+class Identity::EmailVerificationsController < InertiaController
   skip_before_action :authenticate, only: :show
 
   before_action :set_user, only: :show
@@ -10,17 +12,18 @@ def show
 
   def create
     send_email_verification
-    redirect_to root_path, notice: "We sent a verification email to your email address"
+    redirect_back_or_to root_path, notice: "We sent a verification email to your email address"
   end
 
   private
-    def set_user
-      @user = User.find_by_token_for!(:email_verification, params[:sid])
-    rescue StandardError
-      redirect_to edit_identity_email_path, alert: "That email verification link is invalid"
-    end
 
-    def send_email_verification
-      UserMailer.with(user: Current.user).email_verification.deliver_later
-    end
+  def set_user
+    @user = User.find_by_token_for!(:email_verification, params[:sid])
+  rescue StandardError
+    redirect_to edit_identity_email_path, alert: "That email verification link is invalid"
+  end
+
+  def send_email_verification
+    UserMailer.with(user: Current.user).email_verification.deliver_later
+  end
 end