Getting Started

This tutorial assumes that you've already purchased an ABP Commercial license and have an active ABP Commercial account.

This document assumes that you prefer to use MVC / Razor Pages as the UI framework and Entity Framework Core as the database provider. For other options, please change the preference on top of this document.

Setup your development environment

First things first! Let's setup your development environment before creating the first project.

Pre-requirements

The following tools should be installed on your development machine:

• Visual Studio 2022 (v17.3+) for Windows / Visual Studio for Mac. ¹

• .NET 8.0+

• Node v16 or v18

• Yarn v1.20+ (not v2) ² or npm v6+ (already installed with Node)

• Redis (as the distributed cache) is required if you select the Public website option.

¹ You can use another editor instead of Visual Studio as long as it supports .NET Core and ASP.NET Core. ^↩

² Yarn v2 works differently and is not supported. ^↩

Install the ABP CLI

ABP CLI is a command line interface that is used to automate some common tasks for ABP based solutions.

ABP CLI is a free & open source tool for the ABP framework. It is also used for ABP Commercial application development.

First, you need to install the ABP CLI using the following command:

dotnet tool install -g Volo.Abp.Cli

If you've already installed, you can update it using the following command:

dotnet tool update -g Volo.Abp.Cli

Login to your account

In order to use ABP Commercial features, you need to login your account using the ABP CLI:

abp login <username>

It will ask a password, so you must enter the password of your account.

You can freely create a new account from the ABP Account web site. However, your account should be registered to an organization as a developer to be able to use the ABP Commercial. If your company has an ABP Commercial license, ask your manager to add your account to the developer list of the organization.

Install the ABP Suite

ABP Suite is an application aims to assist you on your development.

First, you need to install the ABP Suite:

abp suite install

If you've already installed, you can update it:

abp suite update