mirror of https://github.com/abpframework/abp.git
LiangShiWei
7 years ago
22 changed files with 124 additions and 208 deletions
@ -1,64 +1,30 @@ |
|||
# ABP Documentation |
|||
|
|||
* Getting Started |
|||
* From Startup Templates |
|||
* [ASP.NET Core MVC Template](Getting-Started-AspNetCore-MVC-Template.md) |
|||
* From Empty Projects |
|||
* [With Console Application](Getting-Started-Console-Application.md) |
|||
* [With ASP.NET Core Web Application](Getting-Started-AspNetCore-Application.md) |
|||
* Tutorials |
|||
* Application Development |
|||
* [With ASP.NET Core MVC](Tutorials/AspNetCore-Mvc/Part-I.md) |
|||
* Fundamentals |
|||
* [Dependency Injection](Dependency-Injection.md) |
|||
* [AutoFac Integration](Autofac-Integration.md) |
|||
* [Virtual File System](Virtual-File-System.md) |
|||
* [Localization](Localization.md) |
|||
* [Exception Handling](Exception-Handling.md) |
|||
* Validation |
|||
* Authorization |
|||
* Caching |
|||
* Auditing |
|||
* Setting Management |
|||
* Object to Object Mapping |
|||
* AutoMapper Integration |
|||
* Events |
|||
* Event Bus (local) |
|||
* Distributed Event Bus |
|||
* RabbitMQ Integration |
|||
* Services |
|||
* Object Serialization |
|||
* JSON Serialization |
|||
* Emailing |
|||
* GUIDs |
|||
* Threading |
|||
* Timing |
|||
* [Multi Tenancy](Multi-Tenancy.md) |
|||
* Module Development |
|||
* [Basics](Module-Development-Basics.md) |
|||
* Plug-In Modules |
|||
* [Best Practices](Best-Practices/Index.md) |
|||
* Domain Driven Design |
|||
* Domain Layer |
|||
* [Entities & Aggregate Roots](Entities.md) |
|||
* Value Objects |
|||
* [Repositories](Repositories.md) |
|||
* Domain Services |
|||
* Specifications |
|||
* Application Layer |
|||
* Application Services |
|||
* Data Transfer Objects |
|||
* Unit Of Work |
|||
* ASP.NET Core MVC |
|||
* API Versioning |
|||
* User Interface |
|||
* [Client Side Package Management](AspNetCore/Client-Side-Package-Management.md) |
|||
* [Bundling & Minification](AspNetCore/Bundling-Minification.md) |
|||
* [Tag Helpers](Tag-Helpers.md) |
|||
* [Theming](AspNetCore/Theming.md) |
|||
* Data Access |
|||
* [Entity Framework Core Integration](Entity-Framework-Core.md) |
|||
* [MongoDB Integration](MongoDB.md) |
|||
* Background |
|||
* [Background Jobs](Background-Jobs.md) |
|||
* Testing |
|||
ABP is an **open source application framework** focused on ASP.NET Core based web application development, but also supports developing other types of applications. |
|||
|
|||
Explore the left navigation menu to deep dive in the documentation. |
|||
|
|||
## Project Status |
|||
|
|||
ABP is the **next generation** of the open source [ASP.NET Boilerplate](https://aspnetboilerplate.com/) framework. It's currently in early preview stage and not ready to use in production. The documentation is in progress and currently is very incomplete. |
|||
|
|||
For short-term and production applications, it's suggested to use the [ASP.NET Boilerplate](https://aspnetboilerplate.com/) framework which is feature rich, mature, maintained and up-to-date. |
|||
|
|||
## Getting Started |
|||
|
|||
Easiest way to start a new project with ABP is to use the Startup templates: |
|||
|
|||
* [ASP.NET Core MVC Template](Getting-Started-AspNetCore-MVC-Template.md) |
|||
|
|||
If you want to start from scratch (with an empty project) then manually install the ABP framework, use following tutorials: |
|||
|
|||
* [Console Application](Getting-Started-Console-Application.md) |
|||
* [ASP.NET Core Web Application](Getting-Started-AspNetCore-Application.md) |
|||
|
|||
## Source Code |
|||
|
|||
ABP is being developed on GitHub. See [the source code](https://github.com/abpframework/abp). |
|||
|
|||
## Want to Contribute? |
|||
|
|||
ABP is a community-driven open source project. See [the contribution guide](Contribution/Index.md) if you want to be a part of this project. |
|||
@ -0,0 +1,9 @@ |
|||
# Docs Module |
|||
|
|||
Docs module is used to create technical documentation pages. ABP's [own documentation](https://abp.io/documents/) already using this module. |
|||
|
|||
> Docs module follows the [module architecture best practices](../Best-Practices/Module-Architecture.md) guide. |
|||
|
|||
## Installation |
|||
|
|||
TODO... |
|||
@ -0,0 +1,26 @@ |
|||
# Application Modules |
|||
|
|||
ABP is a **modular application framework** which consists of dozens of **nuget packages**. It also provides a complete infrastructure to build your own application modules which may have entities, services, database integration, APIs, UI components and so on. |
|||
|
|||
There are **two types of modules.** They don't have any structural difference but categorized by functionality and purpose: |
|||
|
|||
* [**Framework modules**](https://github.com/abpframework/abp/tree/master/framework/src): These are **core modules of the framework** like caching, emailing, theming, security, serialization, validation, EF Core integration, MongoDB integration... etc. They do not have application/business functionalities but makes your daily development easier by providing common infrastructure, integration and abstractions. |
|||
* [**Application modules**](https://github.com/abpframework/abp/tree/master/modules): These modules implement specific application/business functionalities like blogging, document management, identity management, tenant management... etc. They generally have their own entities, services, APIs and UI components. |
|||
|
|||
## Open Source Application Modules |
|||
|
|||
There are some **free and open source** application modules developed and maintained by the ABP community: |
|||
|
|||
* **Account**: Used to make user login/register to the application. |
|||
* **Audit Logging**: Used to persist audit logs to a database. |
|||
* **Background Jobs**: Used to persist background jobs when using default background job manager. |
|||
* **Blogging**: Used to create fancy blogs. ABP's [own blog](https://abp.io/blog/abp/) already using this module. |
|||
* [**Docs**](Docs.md): Used to create technical documentation pages. ABP's [own documentation](https://abp.io/documents/) already using this module. |
|||
* **Identity**: Used to manage roles, users and their permissions. |
|||
* **Identity Server**: Integrates to IdentityServer4. |
|||
* **Permission Management**: Used to persist permissions. |
|||
* **Setting Management**: Used to persist settings. |
|||
* **Tenant Management**: Used to manage tenants for a [multi-tenant](../Multi-Tenancy.md) application. |
|||
* **Users**: Used the abstract users, so other modules can depend on this instead of the Identity module. |
|||
|
|||
Documenting the modules is in the progress. See [this repository](https://github.com/abpframework/abp/tree/master/modules) for source code of all modules. |
|||
Loading…
Reference in new issue