Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 2.41 KB

README.md

File metadata and controls

100 lines (75 loc) · 2.41 KB
Raw

Rails Template

Ruby on Rails 7.1 template for generating a new project with some pre-configured settings.

Checkout DEMO of an application.

Login with:

What this template does?

Generates a new Rails project

  • New Rails 7.1 application with PostgreSQL, Bun, Bootstrap and Hotwire.

Equivalent to:

bundle exec rails new <ApplicationName> --database=postgresql --skip-test --javascript=bun --css=bootstrap

Setup development environment

  • Debug tools (Bullet, BetterErrors, LetterOpener, ...).
  • Linters (Overcommit, Rubocop, Reek, Brakeman, ...).

Setup test environment

  • RSpec
  • Capybara
  • FactoryBot
  • Faker
  • Shoulda Matchers

Setup staging environment

  • Add and configure staging environment.

Installs and configures production tools

  • ViewComponent with custom components mapped to Bootstrap components.
  • FontAwesome for icons with ViewComponent nad Stimulus.
  • Pagy for pagination with ViewComponent and Stimulus.
  • Authentication from scratch with Rails 7 best practices.
  • Custom Helpers for common components.
  • I18n ready for multiple languages.

Scaffold (custom generators)

  • Generates scaffold files from UML class diagram with associations, attributes and custom settings.
  • Generates Factories for models.
  • Generates RSpec tests with 100% coverage. (unit, integration, system)

CI/CD

  • Configures Terraform for managing infrastructure on Hetzner Cloud.
  • Configures Dockerfile for various environments.
  • Configures Docker Compose for development and testing.
  • Installs and configures Kamal for deploying Dockerized application to any cloud provider.
  • Configures GitHub Actions for running tests and deploying to Hetzner Cloud with Kamal.

Usage

To generate a new Rails project clone this repository and run the following command:

rails new <ApplicationName> --template=rails_template/template.rb --database=postgresql --skip-test --javascript=bun --css=bootstrap

UML Class Diagram

Parsed model example:

:article => {
  :belongs_to => [
    [0] :user
  ],
  :has_many => [
    [0] :review,
    [1] :comment,
    [2] :technology_assignment
  ],
  :attributes => [
    [0] {
      :name => "title:string",
      :flags => [
        [0] :required,
        [1] :search
      ]
    },
    [1] {
      :name => "content:text",
      :flags => [
        [0] :required
      ]
    }
  ]
}