https://github.com/aaronlasseigne/unifig-rails
https://github.com/aaronlasseigne/unifig-rails
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/aaronlasseigne/unifig-rails
- Owner: AaronLasseigne
- License: mit
- Created: 2022-07-20T03:27:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-30T22:49:20.000Z (over 2 years ago)
- Last Synced: 2025-03-14T17:44:45.809Z (about 1 month ago)
- Language: Ruby
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# [Unifig::Rails][]
Adds [Rails][] support to [Unifig][].
[](https://rubygems.org/gems/unifig-rails)
[](https://github.com/AaronLasseigne/unifig-rails/actions?query=workflow%3ATest)
## Installation
Add it to your Gemfile:
``` rb
gem 'unifig-rails', '~> 0.4.0'
```
Run the configuration generator:
``` sh
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][].
[Unifig::Rails]: https://github.com/AaronLasseigne/unifig-rails
[Rails]: https://rubyonrails.org
[Unifig]: https://github.com/AaronLasseigne/unifig
[documentation]: https://github.com/AaronLasseigne/unifig#usage
[Semantic Versioning]: http://semver.org/spec/v2.0.0.html
[GitHub releases]: https://github.com/AaronLasseigne/unifig-rails/releases
[our contribution guidelines]: CONTRIBUTING.md
[complete list of contributors]: https://github.com/AaronLasseigne/unifig-rails/graphs/contributors
[the MIT License]: LICENSE.txt