Rails Template

Overview

The Abtion Rails Template, also known as Muffi on Rails, is a project template maintained by Abtion. It is used to kick start Ruby on Rails applications. By using this template, developers can save time on first-time setup, as the template includes all the libraries typically used at Abtion on the latest version. The template also provides basic functionality from the start, allowing developers to have the app live and functional from the moment they start.

Features

• Heroku ready - Review apps, staging and production
• Uses devise for authentication
• Uses GitHub Actions for automated testing and deployment
• Uses Jest for JavaScript testing
• Uses rspec for Ruby testing
• Uses rubocop for code linting
• Uses simplecov for code coverage analysis
• Uses i18n-tasks for internationalization tasks

Installation

To start a new project using the Abtion Rails Template:

1. Create a new repository on GitHub and use this repository as the template. (Note: You will lose the template’s history and add everything as one initial commit) Alternatively, import the template into a new repository by going to https://github.com/new/import and specifying https://github.com/abtion/rails-template.git. (Note: You retain all template history)
2. Set up branch protection rules to require status checks before merging and to ensure branches are up to date.
3. Replace the contents of LICENSE.md with the desired license.
4. Configure the project by editing application.rb and changing the module name and configuration settings. Also, edit the database names in database.yml.
5. Use the provided script, bin/replace-project-names, to replace the project name Pascal case in all files. You can also use bin/replace-project-names <param-case-name>.

Summary: The Abtion Rails Template, or Muffi on Rails, is a project template that allows developers to kick start Ruby on Rails applications. It saves time on first-time setup by including all the necessary libraries and providing basic functionality from the start. The template also promotes reliability and scalability, making it easy for developers to switch between similar projects and for new team members to join. With features like automated testing and deployment, the Abtion Rails Template is designed to ensure high-quality software development.