PlatformFramework.EFCore 0.2.0

PlatformFramework

An application framework for building applications on ASP.NET Core

A Web part of framework on top of the PlatformFramework

/ A EntityFramework Core part of framework on top of the PlatformFramework

Work in Progress

• add tests
• stabilize Hooks Api
• review Auth code and features
• derive Context from IdentityContext with configuration
• add tenancy
• add tenant Angular template project

Technologies

• .NET 5
• ASP.NET Core
• Entity Framework Core 3.1
• C# 8.0
• AutoMapper
• Mediatr

Installing

From the Package Manager Console:

PM> Install-Package PlatformFramework
PM> Install-Package PlatformFramework.Web
PM> Install-Package PlatformFramework.EFCore

Getting Started

PlatformFramework

• In your Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddFramework(x =>
        {
            x.Assemblies.Clear();
            x.Assemblies.Add(Assembly.GetExecutingAssembly());
            x.Assemblies.Add(typeof(ApplicationRegistry).Assembly);
        })
        .WithDefaults(); // add default framework services. This can be omitted and replaced by concrete extensions
    
    ....
}

PlatformFramework.Web

• In your Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddWebFramework()
        .WithPermissionAuthorization()
        .WithCors(options =>
        {
            options.AddPolicy("Default", x => x
                .AllowCredentials()
                .SetIsOriginAllowed(isOriginAllowed: _ => true)
                .AllowAnyMethod()
                .AllowAnyHeader());
        })
        .WithResponseCompression(options =>
        {
            options.Providers.Add<BrotliCompressionProvider>();
            options.EnableForHttps = true;
        });
       
    ....
}

PlatformFramework.EFCore

• In your Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddEfCore<ProjectDbContext>(o => //configure DbContext and `IUnitOfWork`
        {
            var connectionString = "__CONNECTION_STRING__";
            o.UseNpgsql(connectionString, assembly => assembly.MigrationsAssembly(Assembly.GetExecutingAssembly().FullName));
        })
        .WithMigrationInitializer() // add DBContext migrator to startup
        .WithHooks(x => // add `on SaveChanges` entity hooks 
        {
            x.WithTrackingHooks();
            x.WithSoftDeletedEntityHook();
        })
        .WithEntities(x => // add Entities to DbContext
        {
            x.ApplyConfiguration<MyEntity, MyEntityConfiguration>();
        });
            
    ....
}

Samples

• Download Visual Studio 2019 (any edition) from https://www.visualstudio.com/downloads/
• Open PlatformFramework.sln and wait for Visual Studio to restore all Nuget packages
• Samples are in to try out (navigate to /swagger for API test)

Contributing

• Clone the repository using the command git clone https://github.com/vermilion/PlatformFramework.git and checkout the master branch. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Licences

Licenced under MIT.