UgenTec Framework Core

Framework core is a collection of libraries developed and maintained by UgenTec to provide a unified API and helper layer for common concerns in the different UgenTec products.

Installation

Framework Core packages are hosted on a new UgenTec nuget feed.

To add this feed to your list of feeds use following settings :

Name : UgenTecNuGet-2

Url : https://pkgs.dev.azure.com/ugentec/_packaging/UgenTecNuGet-2/nuget/v3/index.json

CI integration

Since the 'restore packages' build tasks only allow interactive configuration of a single feed, add a nuget.config file to the root of the solution with following info :

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="UgenTecNuGet-2" value="https://pkgs.dev.azure.com/ugentec/_packaging/UgenTecNuGet-2/nuget/v3/index.json" />
    <add key="UgenTecNuGet" value="https://pkgs.dev.azure.com/ugentec/_packaging/UgenTecNuGet/nuget/v3/index.json" />
    <add key="NuGet official package source" value="https://api.nuget.org/v3/index.json" />
  </packageSources>
</configuration>

When configuring the build pipeline, make sure the build pipeline uses this nuget.config file in stead of pointing to a specific feed.

Packages

UgenTec Framework Core covers 2 types of packages :

• Framework Core Libraries : these contain helpers and extensions for ease of development for specific technical challenges. These API's are designed to be unbiased, extending the usage range beyond UgenTec practices.
• Framework Core Blocks : these are UgenTec opinionated starter blocks, which focus on implementing all UgenTec defaults for application development with as little code as possible.

Libraries

• UgenTec.Framework.Core
• UgenTec.Framework.Core.EntityFramework
• UgenTec.Framework.Core.Http
• UgenTec.Framework.Core.IO
• UgenTec.Framework.Core.Mediator
• UgenTec.Framework.Core.Shared
• UgenTec.Framework.Core.WebApi

Blocks

• UgenTec.Defaults
• UgenTec.MassTransit
• UgenTec.WebApi
• UgenTec.WebApi.Jobs

Changelog

View framework core changelog for all available versions and the changes introduced.

Contributing

Pull requests are welcome. For changes, please open an issue first on our Framework.Core backlog to discuss what you would like to change.

When changing code, also make sure the changes is covered by unittests and all existing tests are updated as appropriate. Also add changes made to the CHANGELOG and extend the documentation.

Documentation

The documentation consists of 2 documentation sources :

1. The api documentation, generated from c# code xml documentation
2. Usage articles, containing quickstarts and samples on how to use Framework Core.

Both are available on the https://frameworkdocs.ugentec.app site.