A Ruby Gem for automating your Config handling
Go to file
Connor C 587c335b8d Update README.md 2024-02-28 21:17:39 -07:00
bin Fix some string interpolation issues 2023-10-13 21:42:20 -06:00
lib Making some fixes regarding calling custom modules 2023-10-27 17:09:12 -06:00
sig upload all the things 2023-10-13 21:16:43 -06:00
spec upload all the things 2023-10-13 21:16:43 -06:00
.gitignore init gem commit 2023-10-13 18:09:22 -06:00
.rspec init gem commit 2023-10-13 18:09:22 -06:00
.rubocop.yml init gem commit 2023-10-13 18:09:22 -06:00
CODE_OF_CONDUCT.md init gem commit 2023-10-13 18:09:22 -06:00
Gemfile Update bundle 2023-10-27 16:42:18 -06:00
Gemfile.lock Update bundle 2023-10-27 16:42:18 -06:00
LICENSE Initial commit 2023-10-13 18:04:34 -06:00
README.md Update README.md 2024-02-28 21:17:39 -07:00
Rakefile upload all the things 2023-10-13 21:16:43 -06:00
configman.gemspec remove deep_dup as a depend 2023-10-14 00:15:59 -06:00


ConfigMan Gem

ConfigMan is a Ruby gem designed to simplify the configuration management of your Ruby applications. It provides a modular approach, allowing you to easily manage different aspects of your application's configuration such as API, Cache, Database, Email, and more. You can even extend its functionality by registering your own custom modules.

If you're new to the Gem, please refer to our Wiki not just this Readme
If you need more direct help, join our Discord

Table of Contents


To install the ConfigMan gem, run the following command:

gem install configman

Or add it to your Gemfile:

gem 'configman'

Then run bundle install.


Built-in Modules

ConfigMan comes with a variety of built-in modules to manage different aspects of your configuration. Here's a quick example:

require 'configman'

default_modules = ['API', 'Cache', 'Database', 'Email', 'FileStorage', 'Localization', 'Logging', 'YAML']

Custom Modules

You can also register your own custom modules to extend the functionality of ConfigMan. Here's how:

require 'configman'
# Register the custom module

# Then proceed with the rest of the setup as usual
default_modules = ['API', 'Cache', 'Database', 'YAML']


For more detailed information and advanced usage, please refer to our Wiki. NOTE: The Wiki is still under construction, apologies for any confusion on usage


Contributions are welcome! Fork the repository to your account on our Git server, make your changes, and submit a PR! We will review, and if we don't find any issues, we will merge the PR! NOTE: Registration is currently disabled while we update some things. We apologize for any inconvenience


This project is licensed under the PixelRidge-BEGPULSE License. See the LICENSE file for details.