🛈 This document usesABP Studio to create new ABP solutions. You can also use theABP CLI to create new solutions and use thegetting started page to easily build ABP CLI commands.
ABP startup solution templates have many options for your specific needs. If you don't understand an option that probably means you don't need it. We selected common defaults for you, so you can leave these options as they are.
Assuming that you haveinstalled and logged in to the application, you should see the following screen when you open ABP Studio:
Select theFile ->New Solution in the main menu, or click theNew solution button on theWelcome screen to open theCreate new solution wizard:
We will use theApplication (Single Layer) solution template for this tutorial, so pick it and click theNext button:
On that screen, you choose a name for your solution. You can use different levels of namespaces; e.g.BookStore,Acme.BookStore orAcme.Retail.BookStore.
Then select anoutput folder to create your solution. TheCreate solution folder option will create a folder in the given output folder with the same name of your solution.
Once your configuration is done, click theNext button to navigate to theUI Framework selection:
Here, you see all the possible UI options supported by that startup solution template. Pick theMVC / Razor Pages.
Notice that; Once you select a UI type, some additional options will be available under the UI Framework list. You can further configure the options or leave them as default and click the Next button for theDatabase Provider selection screen:
On that screen, you can decide on your database provider by selecting one of the provided options. There are some additional options for each database provider. Leave them as default or change them based on your preferences, then click theNext button for additionalDatabase Configurations:
Here, you can select the database management systems (DBMS) and the connection string. Then, click theNext button for additionalMulti-Tenancy selection:
Here, you can enable or disable multi-tenancy for your solution. You can further configure the options or leave them as default and click theNext button for theUI Theme selection screen:
LeptonX is the suggested UI theme that is proper for production usage. Select one of the themes, configure the additional options, and click theNext button for theOptional Modules selection:
Then, you can select optional modules according to your preferences.
Select the modules you want to use in your project; you can disable the ones you don’t need based on your preferences. Then, click theNext button for theLanguage Selection page:
In this step, you can choose which languages your application will support.
Default Language: Select the main language for your app.
Localizable User Interface: Turn this on to support multiple languages.
Available Languages: Check the languages you want to include.
Click Add Custom Language if you want to add a language that is not listed.
You can change these settings later if needed. Thenk click theNext button for theAdditional Options page:
Configure any additional options as needed and click theNext button to continue. On the next screen, you can configure the modularity options for your solution:
If you select theSetup as a modular solution option, the solution is created more ready formodular monolith development and allows you to add sub-modules during the solution creation phase.
Now, we are ready to allow ABP Studio to create our solution. Just click theCreate button and let the ABP Studio do the rest for you.
After clicking theCreate button, the dialog is closed and your solution is loaded into ABP Studio:
You can explore the solution, but you need to wait for background tasks to be completed before running any application in the solution.
Running the Application
After creating your solution, you can open it in your favorite IDE (e.g. Visual Studio, Visual Studio Code or Rider) and start your development. However, ABP Studio provides aSolution Runner system. You can use it to easily run and browse your applications in your solution without needing an external tool.
Open theSolution Runner section on the left side of ABP Studio as shown in the following figure:
The solution runner structure can be different in your case based on the options you've selected.
Once you click thePlay icon on the left side, the section is open in the same place as the Solution Explorer section. ABP Studio also opens theApplication Monitor view on the main content area.Application Monitor shows useful insights for your applications (e.g.HTTP Request,Events, andExceptions) in real-time. You can use it to see the happenings in your applications, so you can easily track errors and many helpful details.
In the Solution Runner section (on the left side) you can see all the runnable applications in the current solution. For the MVC website example, we have only one application:
To start an application, either click thePlay icon near to the application or right-click and select theRun ->Start context menu item.
You can start theAcme.BookStore.
Once theAcme.BookStore application started, you can right-click it and select theBrowse command:
TheBrowse command opens the UI of the web application in the built-in browser:
You can browse your application in a full-featured web browser in ABP Studio. Click theLogin button in the application UI, enteradmin as username and1q2w3E* as password to login to the application.
The following screenshot was taken from theUser Management page of theIdentity module that is pre-installed in the application:
Open the Solution in Visual Studio
You can use any IDE (e.g. Visual Studio, Visual Studio Code or Rider) to develop your solution. Here, we will show Visual Studio as an example.
First of all, we can stop the application(s) in ABP Studio, so it won't conflict when we run it in Visual Studio.
You can use ABP Studio to open the solution with Visual Studio. Right-click to theAcme.BookStoremodule, and select theOpen with ->Visual Studio command:
If theVisual Studio command is not available, that means ABP Studio could not detect it on your computer. You can open the solution folder in your local file system (you can use theOpen with ->Explorer as a shortcut) and manually open the solution in Visual Studio.
Once the solution is opened in Visual Studio, you should see a screen like shown below:
The solution structure can be different in your case based on the options you've selected.
You can then hitF5 orCtrl + F5 to run the web application. It will run and open the application UI in your default browser:
You can useadmin as username and1q2w3E* as default password to login to the application.
