Getting Started

This document assumes that you prefer to use MVC / Razor Pages as the UI framework and MongoDB 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 project.

Pre-Requirements

The following tools should be installed on your development machine:

• An IDE (e.g. Visual Studio) that supports .NET 8.0+ development.

• Node v16 or v18

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

• Redis (the startup solution uses the Redis as the distributed cache).

¹ 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. 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