Rails Templates
Our templates offer a rich boilerplate to jump start Rails-based application development and are based on our experience with building complex applications over the years.
Get Started
Requirements
- Install ruby and set your local ruby version to
3.1.1
- Install rails
7.0.3
- Install node
16.14.2
(For creating web application)
๐ If running on Apple M1, to build docker image, please make sure to set platform to AMD64 by
export DOCKER_DEFAULT_PLATFORM=linux/amd64
Use the template
In order to use the template, initialize a new app with the following parameters:
rails new <app_name> -m https://raw.githubusercontent.com/nimblehq/rails-templates/master/template.rb
Supported template options:
--api
- create an api-only application
To apply the template on an existing application, run following rails command:
rails app:template LOCATION=https://raw.githubusercontent.com/nimblehq/rails-templates/master/template.rb
# To apply on an api application
rails app:template LOCATION=https://raw.githubusercontent.com/nimblehq/rails-templates/master/template.rb API=true
# To apply a specific addon
rails app:template LOCATION=https://raw.githubusercontent.com/nimblehq/rails-templates/master/template.rb ADDON=<addon name>
Available Addons:
docker
nginx
phrase_app
semaphore
bootstrap
slim
devise
Read more about Rails Application Template in the official Rails Guides.
How to contribute
Template structure
.
โโโ .template
โ โโโ addons
โ โ โโโ docker
โ โ โโโ ...
โ โ โโโ template.rb
โ โโโ variants
โ โโโ api
โ โ โโโ ...
โ โ โโโ template.rb
โ โโโ web
โ โโโ ...
โ โโโ template.rb
โโโ app
โโโ bin
โโโ config
โโโ spec
โโโ ...
โโโ README.md
โโโ README.md.tt
โโโ template.rb
We keep the Rails-app-like structure. On the root, there are base project file templates.
Other files including the template options are in .template
folder.
There are 2 kinds of the template options:
-
Variants - For the app main options, which are
web
andapi
. -
Addons - For other extra options that we can add to the project like
docker
orbootstrap
, use the promptask
to generate a question before generating the project.
Template files
There are 2 template file types:
-
.tt
filesThis file is used for templating the whole new file. In case if we want to create a new file that Rails does not generated.
-
.rb
filesThis is used for modifying the files that Rails has generated. The file name should be the same as on the generated app. If it is not a ruby file, append the
.rb
as an extension e.g.Gemfile.rb
Template specs
We are using Serverspec to test the template. For any changes made, you must add a spec for it.
Test files are located under .template/spec
folder
.
โโโ ...
โโโ .template
โ โโโ ...
โ โโโ spec
โ โ โโโ addons
โ โ โ โโโ base
โ โ โ โ โโโ docker
โ โ โ โ โ โโโ ...
โ โ โ โ โ โโโ template_spec.rb
โ โ โ โ โโโ semaphore
โ โ โ โ โ โโโ ...
โ โ โ โ โ โโโ template_spec.rb
โ โ โ โโโ variants
โ โ โ โ โโโ web
โ โ โ โ โ โโโ boostrap
โ โ โ โ โ โโโ ...
โ โ โ โ โ โโโ template_spec.rb
โ โ โ โ โโโ api
โ โ โ โ โ โโโ addon
โ โ โ โ โ โโโ ...
โ โ โ โ โ โโโ template_spec.rb
โ โ โโโ base
โ โ โ โโโ ...
โ โ โ โโโ template_spec.rb
โ โ โโโ variants
โ โ โ โโโ web
โ โ โ โ โโโ ...
โ โ โ โ โโโ template_spec.rb
โ โ โ โโโ api
โ โ โ โ โโโ ...
โ โ โ โ โโโ template_spec.rb
Template Strings
When using template string with heredoc, use the proper name following the file type / content.
This provides the meaningful context to the content and some IDEs also support to highlight the content depending on the type.
DOCKERFILE
ERB
HTML
IGNORE
- For any ignore file e.g..gitignore
,.eslintignore
JAVASCRIPT
JSON
PROCFILE
RUBY
SCSS
SHELL
For other files that are not fit the types above, use the extension as the name
e.g. TOOL_VERSION
for .tool-version
file.
For the normal string, name it after the content
e.g. ERROR
for template error message.
Testing the Template
To run RuboCop against the template:
.template/bin/rubocop
Any RuboCop command options can be passed:
# Run RuboCop with auto correct
.template/bin/rubocop -a
License
This project is Copyright (c) 2014 and onwards. It is free software, and may be redistributed under the terms specified in the LICENSE file.
About
This project is maintained and funded by Nimble.
We love open source and do our part in sharing our work with the community! See our other projects or hire our team to help build your product.