jro7/template-rails

repo to get started with Rails 7, tailwind, esbuild and edit in gitpod.io

Template to start a new Rails 7 project

I wanted a relatively quick way to start a new Ruby on Rails project, without the need to setup my local machine with all the correct versions of Ruby & gems.

The rails new command installs Rails with support for Postgresql, Tailwind CSS and esbuild.

Heavily inspired by https://github.com/pskarlas/rails_fast_dev as starting point.

Main addition was editing in Gitpod.

Usage

1. clone repository or click on Use this template

2. edit new repository in Gitpod (ie. https://gitpod.io/#https://github.com/<your_username>/<your_repository>)

   Gitpod automatically recognizes the Dockerfile and does a bundle install, if the following command fails, run bundle install first

3. create your new rails environment, example commands:

   1. basic rails with TailwindCSS and importmaps(default):
      bundle exec rails new . --css tailwind --database postgresql
   2. or more custom for example TailwindCSS, esbuild and no tests:
      bundle exec rails new . --javascript esbuild --css tailwind --database postgresql -T

You can choose to answer yes/all to "overwrite the following file(s)", since it's in git ;). But don't forget you will need to add the gitpod setting below if you want to preview the app straight from Gitpod

Start

Run bin/dev to start rails

Edit and preview on Gitpod

It's possible to run the app on gitpod, add the following to ./config/environment/development.rb, on top of the file after the line Rails.application.configure do

  # Preview on Gitpod
  config.hosts << ENV["APP_DOMAIN"] unless ENV["APP_DOMAIN"].nil?
  if (gitpod_workspace_url = ENV["GITPOD_WORKSPACE_URL"])
    config.hosts << /.*#{URI.parse(gitpod_workspace_url).host}/
  end