Skip to content

Latest commit

 

History

History
73 lines (44 loc) · 2.91 KB

Getting-Started-Create-Solution.md

File metadata and controls

73 lines (44 loc) · 2.91 KB
Raw

Getting Started

//[doc-params]
{
    "UI": ["MVC", "Blazor", "BlazorServer", "NG"],
    "DB": ["EF", "Mongo"],
    "Tiered": ["Yes", "No"]
}

This document assumes that you prefer to use {{ UI_Value }} as the UI framework and {{ DB_Value }} as the database provider. For other options, please change the preference on top of this document.

Create a New Project

We will use the ABP CLI to create a new ABP project.

Alternatively, you can create and download projects from the ABP Framework website by easily selecting all options from the page.

Use the new command of the ABP CLI to create a new project:

abp new Acme.BookStore{{if UI == "NG"}} -u angular{{else if UI == "Blazor"}} -u blazor{{else if UI == "BlazorServer"}} -u blazor-server{{end}}{{if DB == "Mongo"}} -d mongodb{{end}}{{if Tiered == "Yes"}}{{if UI == "MVC" || UI == "BlazorServer"}} --tiered{{else}} --separate-auth-server{{end}}{{end}}

You can use different level of namespaces; e.g. BookStore, Acme.BookStore or Acme.Retail.BookStore.

{{ if Tiered == "Yes" }}

{{ if UI == "MVC" || UI == "BlazorServer" }}

  • --tiered argument is used to create N-tiered solution where authentication server, UI and API layers are physically separated.

{{ else }}

  • --separate-auth-server argument is used to separate the Auth Server application from the API host application. If not specified, you will have a single endpoint on the server.

{{ end }}

{{ end }}

ABP CLI document covers all of the available commands and options.

Mobile Development

If you want to include a React Native project in your solution, add -m react-native (or --mobile react-native) argument to project creation command. This is a basic React Native startup template to develop mobile applications integrated to your ABP based backends.

See the Getting Started with the React Native document to learn how to configure and run the React Native application.

The Solution Structure

The solution has a layered structure (based on the Domain Driven Design) and contains unit & integration test projects. See the application template document to understand the solution structure in details.

{{ if DB == "Mongo" }}

MongoDB Transactions

The startup template disables transactions in the .MongoDB project by default. If your MongoDB server supports transactions, you can enable it in the YourProjectMongoDbModule class's ConfigureServices method:

Configure<AbpUnitOfWorkDefaultOptions>(options =>
{
  options.TransactionBehavior = UnitOfWorkTransactionBehavior.Auto;
});

Or you can delete that code since Auto is already the default behavior.

{{ end }}

Next Step