Baubit 2025.7.8

Baubit is a framework for developing modular apps in .NET

Get started

Creating a module requires creating at least 2 classes - One for the module itself and another for the associated configuration

public class MyConfiguration : AConfiguration
{
  public string MyStringProperty { get; set; }
}

public class MyModule : AModule<MyConfiguration>
{
  protected MyModule(ConfigurationSource configurationSource) : base(configurationSource)
  {

  }

  protected MyModule(IConfiguration configuration) : base(configuration)
  {

  }
  protected MyModule(MyConfiguration configuration,
                     List<AModule> nestedModules) : base(configuration, nestedModules)
  {
  }
  public override void Load(IServiceCollection services)
  {
    var myStrProp = Configuration.MyStringProperty;
    // add required services to the IServiceCollection based on the module's configuration
    base.Load(services);
  }
}

Loading modules

myConfig.json

{
  "modules": [
    {
      "type": "MyProject.MyModule, MyProject",
      "parameters": {
        "configuration": {
          "myStringProperty" : "some string value"
          }
        }
    }
  ]
}

Using HostApplicationBuilder

var hostApplicationBuilder = new HostApplicationBuilder();
hostApplicationBuilder.Configuration.AddJsonFile("myConfig.json");
new ServiceProviderFactoryRegistrar().UseDefaultServiceProviderFactory(hostApplicationBuilder);
var host = hostApplicationBuilder.Build();
host.Run();

Using WebApplicationBuilder

var webAppBuilder = WebApplication.CreateBuilder();
webAppBuilder.Configuration.AddJsonFile("myConfig.json");
new ServiceProviderFactoryRegistrar().UseDefaultServiceProviderFactory(webAppBuilder.Host);
var webApp = webAppBuilder.Build()
webApp.Run();

Nesting Modules

Modules can be loaded side by side. <br> They can also be loaded as a nested module (sub-module)

public class AnotherModuleConfiguration : AConfiguration
{
  public string AnotherStringProperty { get; set; }
}

public class AnotherModule : AModule<AnotherModuleConfiguration>
{
  protected AnotherModule(ConfigurationSource configurationSource) : base(configurationSource)
  {

  }

  protected AnotherModule(IConfiguration configuration) : base(configuration)
  {

  }
  protected AnotherModule(AnotherModuleConfiguration configuration,
                          List<AModule> nestedModules) : base(configuration, nestedModules)
  {
  }
  public override void Load(IServiceCollection services)
  {
    var anotherStringProperty = Configuration.AnotherStringProperty;
    // add required services to the IServiceCollection based on the module's configuration
    base.Load(services);
  }
}

myConfig.json

{
  "modules": [
    {
      "type": "MyProject.MyModule, MyProject",
      "parameters": {
        "configuration": {
          "myStringProperty" : "some string value",
          "modules": [
              {
                "type": "MyProject.AnotherModule, MyProject",
                "parameters": {
                  "configuration": {
                    "anotherStringProperty" : "another string value"
                    }
                  }
              }
            ]
          }
        }
    }
  ]
}

Linking configurations

Module configurations can be loaded by referencing a json file<br> myConfig.json

{
  "modules": [
    {
      "type": "MyProject.MyModule, MyProject",
      "parameters": {
        "configuration": {
          "myStringProperty" : "some string value",
          "modules": [
              {
                "type": "MyProject.AnotherModule, MyProject",
                "parameters": {
                  "configurationSource": {
                    "jsonUriStrings" : ["anotherModule.json"]
                    }
                  }
              }
            ]
          }
        }
    }
  ]
}

anotherModule.json

{
  "anotherStringProperty" : "another string value"
}