Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.57 KB

README.adoc

File metadata and controls

59 lines (44 loc) · 2.57 KB
Raw

badge Quality Gate Status License Maven

SmallRye Config

SmallRye Config is a library that provides a way to configure applications, frameworks and containers. It is used in applications servers like WildFly, Open Liberty and TomEE, or frameworks like Quarkus. It can also be used completely standalone in any Java application, which makes it a very flexible library.

It follows the MicroProfile Config specification to provide the initial config foundations and expands with it own concepts to cover a wide range of use cases observed in the configuration space.

Instructions

Compile and test the project:

mvn verify

Generate the documentation (from the documentation folder):

mvn package
mkdocs serve

Project structure

  • cdi - CDI Extension

  • common - A set of reusable components to extend SmallRye Config

  • converters - Additional Converters

  • documentation - Project documentation

  • examples - Examples projects to demonstrate SmallRye Config features

  • implementation - Implementation of SmallRye Config

  • sources - Implementation of custom Config Sources

  • testsuite - Test suite to run the implementation against the MicroProfile Config TCK

  • utils - A set of additional extensions to enhance SmallRye Config

  • validator - Bean Validation integration

Contributing

Please refer to our Wiki for the Contribution Guidelines.