abp README

The project's README from github.com/abpframework/abp. As one markdown file: README.md.

build and test 🔹 codecov 🔹 NuGet 🔹 NuGet (with prereleases) 🔹 MyGet (nightly builds) 🔹 NuGet Download 🔹 Code of Conduct 🔹 CLA Signed 🔹 Discord Shield

ABP offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET and the ASP.NET Core platforms. It provides the fundamental infrastructure, production-ready startup templates, pre-built application modules, UI themes, tooling, guides and documentation to implement that architecture properly and automate the details and repetitive works as much as possible.

ABP Platform

Getting Started

What ABP Provides?

ABP bridges the gap between ASP.NET Core and real-world business application requirements, and makes you focus on your own business code.

The following diagram contains the core components of the ABP Platform and shows how ABP sits between ASP.NET Core and Your Application:

abp-overall-diagram

Architecture

ABP offers a complete architectural model to build modern enterprise software solutions. Here, the fundamental architectural structures offered and first-class supported by ABP:

Infrastructure

There are a lot of infrastructure features provided by the ABP Framework to achieve real-world scenarios easier, like Event Bus, Background Job System, Audit Logging, BLOB Storing, Data Seeding, Data Filtering, and much more.

See ABP Framework features

Cross-Cutting Concerns

ABP also simplifies (and even automates wherever possible) cross-cutting concerns and common non-functional requirements like Exception Handling, Validation, Authorization, Localization, Caching, Dependency Injection, Setting Management, etc.

Application Modules

ABP is a modular framework and the application modules provide pre-built application functionalities.

Some examples:

See all official modules.

Startup Templates

The Startup templates are pre-built Visual Studio solution templates. You can create your own solution based on these templates to immediately start your development.

Tooling

ABP provides CLI and UI tools to simplify your daily development work flows.

ABP Studio

ABP Studio is a cross-platform desktop application for ABP developers.

It is well integrated to the ABP Framework and aims to provide a comfortable development environment for you by automating things, providing insights about your solution, making develop, run and deploy your solutions much easier.

ABP Suite

ABP Suite allows you to automatically generate web pages in a matter of minutes.

ABP CLI

ABP CLI is a command line tool to perform common operations for ABP based solutions.

Mastering ABP Framework Book

This book will help you to gain a complete understanding of the ABP Framework and modern web application development techniques. It is written by the creator and team lead of the ABP Framework. You can buy from Amazon or Packt Publishing. Find further info about the book at abp.io/books/mastering-abp-framework.

book-mastering-abp-framework

The Community

ABP Community Web Site

The ABP Community is a central hub to publish articles and share knowledge about the ABP Framework.

Blog

Follow the ABP Blog to learn the latest happenings in the ABP Framework.

Samples

See the sample projects built with the ABP Framework.

Want to Contribute?

ABP is a community-driven open-source project. See the contribution guide if you want to participate in this project.

Support ABP

GitHub repository stars are an important indicator of popularity and the size of the community. If you like ABP Framework, support us by clicking the star :star: on the repository.

Discord Server

We have a Discord server where you can chat with other ABP users. Share your ideas, report technical issues, showcase your creations, share the tips that worked for you and catch up with the latest news and announcements about ABP Framework. Join 👉 https://abp.io/join-discord.

abp (abpframework/abp)

c-sharp
Searching Database…

14.4K ·GitHub
What is this?ABP is an open-source web application framework for ASP.NET Core that gives you an opinionated architecture for building enterprise software, with infrastructure, startup templates, pre-built application modules, UI themes and tooling included.
Is this a framework or just a set of libraries?It is a full framework: it provides architectural patterns (DDD, microservices, modularity, multi-tenancy), cross-cutting concern implementations, CLI/UI tooling, and ready-made startup templates rather than a single library you drop in.
How do I create a new ABP-based project?Use the Getting Started guide or the Quick Start tutorial to scaffold a solution from the pre-built Visual Studio startup templates, or use the ABP CLI / ABP Suite tooling to generate and run it.
What do I need installed before using ABP?You need the .NET platform (ASP.NET Core) since ABP is built directly on top of it; for the full tooling experience you'd also use the ABP CLI or ABP Studio desktop app.
Is ABP a lightweight add-on or a big commitment?It's opinionated and fairly heavy: it brings its own architecture (DDD, modularity, multi-tenancy) and conventions, so adopting it means building around ABP's structure rather than a thin library you can bolt on casually.
What front-end options does it support?ABP supports multiple UI stacks including Angular and Blazor alongside the traditional ASP.NET Core MVC/Razor UI, based on the startup templates you choose.
What is ABP Studio?ABP Studio is a cross-platform desktop application for ABP developers that integrates with the framework to automate tasks, provide solution insights, and make developing, running and deploying ABP solutions easier.
What is ABP Suite?ABP Suite is a tool that automatically generates web pages (CRUD UIs) for your ABP solution in minutes, reducing repetitive coding work.
Can ABP be used for microservices, not just monoliths?Yes, ABP has first-class support for microservice architecture, including a dedicated tutorial covering independent services, inter-service communication, and API Gateway setup.
Does ABP help with multi-tenant SaaS apps?Yes, multi-tenancy is one of ABP's core architectural features, and it includes a SaaS module for managing tenants and editions out of the box.
Size
3 GB
Stars
14.4K
Age
9y
Commits · 90 Days