aspnetboilerplate / aspnetboilerplate

ASP.NET Boilerplate - Web Application Framework

ASP.NET Boilerplate

What is ABP?

ASP.NET Boilerplate is a general purpose application framework specially designed for new modern web applications. It uses already familiar tools and implements best practices around them to provide you a SOLID development experience.

ASP.NET Boilerplate works with the latest ASP.NET Core & EF Core but also supports ASP.NET MVC 5.x & EF 6.x as well.

Modular Design

Designed to be modular and extensible, ABP provides the infrastructure to build your own modules, too.

Multi-Tenancy

SaaS applications made easy! Integrated multi-tenancy from database to UI.

Well-Documented

Comprehensive documentation and quick start tutorials.

How It Works

Don't Repeat Yourself! ASP.NET Boilerplate automates common software development tasks by convention. You focus on your business code!

See the Introduction document for more details.

Layered Architecture

ABP provides a layered architectural model based on Domain Driven Design and provides a SOLID model for your application.

See the NLayer Architecture document for more details.

Nuget Packages

ASP.NET Boilerplate is distributed as NuGet packages.

Package	Status
Abp
Abp.AspNetCore
Abp.Web.Common
Abp.Web
Abp.Web.Mvc
Abp.Web.Api
Abp.Web.Api.OData
Abp.Web.Resources
Abp.Web.SignalR
Abp.Owin
Abp.EntityFramework.Common
Abp.EntityFramework
Abp.EntityFramework.GraphDiff
Abp.EntityFrameworkCore
Abp.NHibernate
Abp.Dapper
Abp.FluentMigrator
Abp.AspNetCore
Abp.AspNetCore.SignalR
Abp.AutoMapper
Abp.HangFire
Abp.HangFire.AspNetCore
Abp.Castle.Log4Net
Abp.RedisCache
Abp.RedisCache.ProtoBuf
Abp.MailKit
Abp.Quartz
Abp.TestBase
Abp.AspNetCore.TestBase

Module Zero

What is 'Module Zero'?

This is an ASP.NET Boilerplate module integrated with Microsoft ASP.NET Identity.

Implements abstract concepts of ASP.NET Boilerplate framework:

• Setting store
• Audit log store
• Background job store
• Feature store
• Notification store
• Permission checker

Also adds common enterprise application features:

• User, Role and Permission management for applications that require authentication and authorization.
• Tenant and Edition management for SaaS applications.
• Organization Units management.
• Language and localization text management.
• Identity Server 4 integration.

Module Zero packages define entities and implement base domain logic for these concepts.

NuGet Packages

ASP.NET Core Identity Packages

Packages integrated into ASP.NET Core Identity and Identity Server 4 (supports .NET Standard).

Package	Status
Abp.ZeroCore
Abp.ZeroCore.EntityFrameworkCore
Abp.ZeroCore.IdentityServer4
Abp.ZeroCore.IdentityServer4.EntityFrameworkCore
Abp.ZeroCore.IdentityServer4.vNext
Abp.ZeroCore.IdentityServer4.vNext.EntityFrameworkCore

ASP.NET Identity Packages

Packages integrated into ASP.NET Identity 2.x.

Package	Status
Abp.Zero
Abp.Zero.Owin
Abp.Zero.AspNetCore
Abp.Zero.EntityFramework

Shared Packages

Shared packages between the Abp.ZeroCore.* and Abp.Zero.* packages.

Package	Status
Abp.Zero.Common
Abp.Zero.Ldap

Startup Templates

You can create your project from startup templates to easily start with Module Zero:

• ASP.NET Core & Angular based startup project.
• ASP.NET Core MVC & jQuery based startup project.
• ASP.NET Core MVC 5.x / AngularJS based startup project.

A screenshot of the ASP.NET Core based startup template:

Links

• Web site & Documentation: https://aspnetboilerplate.com
• Questions & Answers: https://stackoverflow.com/questions/tagged/aspnetboilerplate?sort=newest

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.

License

MIT.

aspnetboilerplate's Issues

Database

I can't get Taskever to work, it complains about the database.

I created a blank DB, but still errors.

Shouldn't this work out of the box, or am I missing something?

Add a IDeletionAudited

Add a IDeletionAdudited interface that extends ISoftDelete and adds a 'long? DeleterUserId' and a 'DateTime? DeletionDate'.
Then we should automatically set this property on soft delete!

Send validation errors to client.

Implement a way of sending validation errors to the client on AJAX requests.

Angular $http service interceptors

Develop an interceptor to manipulate responses from server on http calls.

EventBus.TriggerUow extension method

Create an extension method to trigger events in a unit of work. Triggered events actually triggered after uow success.

Dynamic parameters in ConventionalRegistrationConfig

Allow custom parameters in ConventionalRegistrationConfig class.

Loading modules

There is a problem on loading modules. AppDomain.CurrentDomain.GetAssemblies() doesn't work since all assemblies are not loaded on startup. So, must find a proper way of resolving dependencies and initializing modules.

Always use UTC datetime

Using local times leads application proper for single time zone. It should save times to database in UTC. Also send/receive UTC times between server and client.

Seperate DB operations from Core module's SettingManager

IApplicationService methods should be transactional as default

IApplicationService methods should be transactional as default

Log validation errors

Log all validation errors as 'warn' in server side.

Running as vitrual directory in iis

Currently, ABP samples work properly in IIS if we deploy as web site. But there may be some problems if it's deployed in a virtual directory.

Should lazy initialize on static constructors.

In SettingHelper and LocalizationHelper static constructores, we should use Lazy class instead of directly calling IocHelper.

Infinite depth in dynamic controller addresses.

Allow infinite depth. Current depth is 2. It is like: 'areaName/serviceName'.

EntityFramework support

Complete basic EntityFramework module.

• It can work with more than one dbcontexes.
• It can enable extending entities without polymorphism.

Set audit informations on SaveChanges() for EntityFramework.

Currently it's done in a repository interceptor but user can add/modify entities differently.

Add IShouldNormalize to be used by DTOs

IShouldNormalize interface can be implemented by DTO objects to normalize before method execution.

Enchance IsTransactional property

In a non-transactional scope, we may need to enter a transactional scope. So, should also handle it and start/commit transaction for this scope.

Change UserId from int to long.

ASP.NET Identity Framework Implementation

Implement ASP.NET Identity Framework, so;

• Implement in Abp.Core module
• Use custom (AbpUsers, AbpRoles...) tables
• Use custom (User, Role...) entities
• Allow user to extend entities and tables
• Use NHibernate
• Use ASP.NET Identity framework 2.0

ISoftDelete implementation for EntityFramework

Do not delete, just mark as deleted entities implement ISoftDelete.
Do not retrive entities with IsDeleted = true.

Change name of ISoftDeleteEntity to ISoftDelete

Permission based authorization system

Build a authorization system that checks permissions for methods/actions. Permissions can be granted for roles and users.

Set audit informations on NHibernate interceptor

Currently it's done in repository interceptors.

UnitOfWork.AddSuccessHandler method

Can be added handlers those will be called when current uow succeed.

enhance javascript log api

• Write string logs in single-line.
• Set info/warn/error icons on console.
• Define abp.log.logger(loggerName) to get a logger with specific name. Then we can show/hide logs by loggerName. (like Log4Net)
• May define logFormat (may write time and loggerName before log)
• May use angular's logging where possible?

enhance UnitOfWorkScope class

Use upper-level scope instead of starting new when available.

Split IUnitOfWork methods

Split IUnitOfWork methods, so methods should be called by ABP should be seperated. Initialize, Begin, End and Cancel are should be called by only ABP!
IsTransactional, SaveChanges and OnSuccess can be used also by users.

Add 'IsTransactional' property to UnitOfWorkAttribute

This is needed since somethimes we do not need transactions. We may just query from database. Add a IsTransactional property to UnitOfWork attribute.

Not registering uow if class has only non-public uow attributes

Background task schedule system

Develop a system that we can scnedule and queue background tasks.

A task consists of;

• A class implements IBackgroundTask (or something like that)
• A schedule (one time, hourly, daily... etc).

There should be a schedular class that can be worked in single or multiple threaded. Their working should be logged (and measured duration optionally) and so on...

This schedular should work in IIS process. Thus, application should be alive always. If it's not a web app, it should work in-process.

This may be a good feature of an application framework.

NOTE: We should implement these feature as extensible. Also, anyone may want to use Quartz.Net or other tools. So, it should be possible to create adapters to these libraries.

Dynamic javascript proxy for AngularJs

Dynamic javascript proxy creation should be adapted for AngularJs.
It should use Angular's $http instead of jQuery's ajax.
It also should register services to an 'abp' module.

Move scripts/styles from abp.web.mvc to abp.web

Add 'Create' method to IRepository

EntityFramework implements Create. We can create for NH also.
Try that before implement.

Make EventBus to handle events with base event data types like concrete types.

We should be able to register a handler for a base event data class and capture events for this class and derived classes.

It does not return message of UserFriendlyException.

It does not return message of UserFriendlyException to the user. It returns standard error message.

Make validation in MVC and Web API actions same as application services

Make validation in MVC and Web API actions same as application services.
They should use IShouldNormalize and ICustomValidate as like DTOs.

Generate batch dynamic proxy

Javascript proxies are generated per application service. It's needed also genarete a single javascript file for all.

Remove unnecessary log4net dependencies

Prevent changing creation audits on modifying

CreationTime and CreationUserId can be set only at first insert to database. Later it should not be updated!
Also, Deletion audits can not be set if not deleting the entity.

Dyanmic javascript service proxy should be independent from require.js

It should support require.js but can be used like examples below:

abp.services.taskever.task.create(...);

Taskever migrations

When running the Taskever migrations using the file: RunMigrations.bat I receive an error when creating 'CreateForeignKey FK_TeTasks_AssignedUserId_AbpUsers_Id TeTasks(AssignedUserId) AbpUsers(Id)' as the table dbo.AbpUsers does not yet exist. See attached screenshot.

Am I missing some Migrations?

Regards

Walter

Prevent Concurrency Conflicts

The reason I'm such a huge fan of checking for this is that most web applications have multiple users. Take your TaskEver example, a task could easily be updated by more than one user at the same time, thus creating the concurrency conflict.

"A concurrency conflict occurs when one user displays an entity's data in order to edit it, and then another user updates the same entity's data before the first user's change is written to the database. If you don't enable the detection of such conflicts, whoever updates the database last overwrites the other user's changes. In many applications, this risk is acceptable: if there are few users, or few updates, or if isn't really critical if some changes are overwritten, the cost of programming for concurrency might outweigh the benefit. In that case, you don't have to configure the application to handle concurrency conflicts."

Example of how this can be done.
http://www.asp.net/mvc/tutorials/getting-started-with-ef-using-mvc/handling-concurrency-with-the-entity-framework-in-an-asp-net-mvc-application

Add UnitOfWorkScope.Current.SaveChanges

This will help us to save changes when we need.

Recursive DTO validation

ABP now validates an input DTO. It should also validate if a property of the DTO is another DTO that implements IValidate. This should be done recursively.

Create a base ApplicationService class

It can contain Logger and Localization methods as like MVC controllers.

@halil: Are same needs exists for domain services and other classes? Is it good for a general-purpose helper base class? Or it breaks best practices? Think that...

Global filters for ISoftDelete for NHibernate

Global filters for ISoftDelete for NHibernate

Change name of AddSuccessHandler to OnSuccess

Provide using cshtml files without AbpAppViewController

It will be better to provide a way of using cshtml in SPAs, files without AbpAppViewController. If it's no possible, we may add a js function as a shortcut.

Enhance & fix handling MVC Errors