Skip to content

infinum/rails-template

Rails application generator template

Description

The template for generating new Rails applications.

Table of contents

Getting started

To setup development environment run bin/setup.

Usage

rails new myapp -m https://raw.githubusercontent.com/infinum/rails-template/refs/heads/main/template.rb

Architecture

This project aims to provide Rails Application Template for initializing a Rails application with the Infinum Team Rails standard settings. Entrypoint file template.rb is evaluated in the context of a Rails App generator, which itself is a Thor::Group. It

  • clones this repository in a temporary directory
  • adds templates/ directory to the list of source_paths (docs)
  • applies the recipes/main.rb recipe

A recipe is a file that groups related operations for a Rails Application Template.

Post-apply instructions

In some situations (e.g., lack of information, complex configuration structure), it's more efficient for a user to manually define the configuration. Use templates/SETUP.md to convey the instructions that the application development team should complete after applying the template.

Contributing

We believe that the community can help us improve and build better a product. Please refer to our contributing guide to learn about the types of contributions we accept and the process for submitting them.

To ensure that our community remains respectful and professional, we defined a code of conduct that we expect all contributors to follow.

We appreciate your interest and look forward to your contributions.

License

Copyright 2024 Infinum

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Credits

Maintained and sponsored by Infinum.

About

No description or website provided.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8