Skip to content

AaronLasseigne/unifig-rails

Repository files navigation

Adds Rails support to Unifig.

Version Test

Installation

Add it to your Gemfile:

gem 'unifig-rails', '~> 0.4.0'

Run the configuration generator:

bundle exec rails generate unifig:config

This project uses Semantic Versioning. Check out GitHub releases for a detailed list of changes.

Usage

Once your Rails app has been started you will be able use Unifig with the setup you've created in config/unifig.yml.

For information on how to use Unifig see the documentation for that gem.

If you need to know more information about the variables in Unifig you can run rake unifig:vars and get a listing.

> rake unifig:vars
┌────────┬────────────────┬──────────┬──────────┬─────────┐
│        │                │          │          │         │
│ Var    │ Value          │ Provider │ Required │ Method  │
├────────┼────────────────┼──────────┼──────────┼─────────┤
│        │                │          │          │         │
│ HOME   │ "/Users/aaron" │ env      │ true     │ .home   │
│        │                │          │          │         │
│ NAME   │ "Aaron"        │ local    │ true     │ .name   │
│        │                │          │          │         │
│ HELLO  │ "hi \"Aaron\"" │ local    │ false    │ .hello  │
└────────┴────────────────┴──────────┴──────────┴─────────┘

Contributing

If you want to contribute to Unifig::Rails, please read our contribution guidelines. A complete list of contributors is available on GitHub.

License

Unifig is licensed under the MIT License.