MarsBased / pathfinder-rails

Rails Template for MarsBased projects

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pathfinder Waffle

Pathfinder

Rails Template for MarsBased projects.

Usage

The recommended way to use it is referencing the template directly from the Github repository.

rails new new_app -m https://raw.githubusercontent.com/MarsBased/pathfinder-rails/master/template.rb --skip-turbolinks

Note: You need to have installed Yarn before starting a new project since Rails 5.1 uses it as default JavaScript package manager. You can follow this installation instructions.

How does it work

Usually, Rails templates are being built from a single template file. However, if you want to create more complex templates, managing everything this way is painful.

For this reason, we have organized the project in several recipes that can be applied based on the user feedback.

The template.rb file will first clone the whole Pathfinder repository into a temporary local folder and then will execute itself.

Contributing

You just need to clone the repository

git clone git@github.com:MarsBased/pathfinder-rails.git

make the desired changes and test it locally by using:

rails new new_app -m pathfinder_local_repo/template.rb --skip-turbolinks

About

Rails Template for MarsBased projects

License:MIT License


Languages

Language:Ruby 100.0%