mirror of https://github.com/abpframework/abp.git
committed by
GitHub
6 changed files with 87 additions and 17 deletions
@ -0,0 +1,72 @@ |
|||||
|
# Prerequisites for Developing ABP Applications |
||||
|
|
||||
|
This document will guide you through preparing your development environment for ABP based application development. |
||||
|
|
||||
|
## IDE |
||||
|
|
||||
|
You need to use an IDE that supports .NET development. The following IDEs are the most popular ones for .NET development. |
||||
|
|
||||
|
### Visual Studio |
||||
|
|
||||
|
Visual Studio is Microsoft's IDE and is the de facto tool for developing .NET projects. You can download Visual Studio from the [Visual Studio official website](https://visualstudio.microsoft.com/). It also has a **free Community edition** which is more than enough for ABP projects. |
||||
|
|
||||
|
### Visual Studio Code |
||||
|
|
||||
|
Visual Studio Code is a **free and cross-platform** lightweight code editor that supports .NET development. You can [download from here](https://code.visualstudio.com/download). |
||||
|
|
||||
|
### JetBrains Rider |
||||
|
|
||||
|
[JetBrains Rider](https://www.jetbrains.com/rider/download) is a cross-platform IDE by [JetBrains](https://www.jetbrains.com/) that supports .NET development. It is **[free for non-commercial use](https://blog.jetbrains.com/blog/2024/10/24/webstorm-and-rider-are-now-free-for-non-commercial-use/)**. |
||||
|
|
||||
|
## .NET SDK |
||||
|
|
||||
|
ABP is based on NET, so you need to install the .NET SDK. You can download the .NET SDK from the [.NET official website](https://dotnet.microsoft.com/en-us/download/dotnet/9.0). |
||||
|
|
||||
|
> Installing Visual Studio or JetBrains Rider may automatically install the .NET SDK. |
||||
|
|
||||
|
### EF Core CLI |
||||
|
|
||||
|
If you are using [Entity Framework Core](https://learn.microsoft.com/en-us/ef/core/) as your database access provider, you need to install the [EF Core CLI](https://learn.microsoft.com/en-us/ef/core/cli/dotnet). You can install it by running the following command: |
||||
|
|
||||
|
```bash |
||||
|
dotnet tool install --global dotnet-ef |
||||
|
``` |
||||
|
|
||||
|
If you have already installed the `EF Core CLI`, you can update it by running the following command: |
||||
|
|
||||
|
```bash |
||||
|
dotnet tool update --global dotnet-ef |
||||
|
``` |
||||
|
|
||||
|
## Node.js and Yarn |
||||
|
|
||||
|
ABP projects include some frontend resource packages, so you need to install Node.js and Yarn to manage these resource packages. You can download Node.js from the [official Node.js website](https://nodejs.org/). We recommend installing version v20.11+. |
||||
|
|
||||
|
Using Yarn (classic) to manage frontend resource packages is faster and more stable than using npm. You can download `Yarn` from the [Yarn official website](https://classic.yarnpkg.com/en/docs/install). We recommend installing Yarn v1.22+ (make sure to install the Classic version, not v2+). |
||||
|
|
||||
|
To install Yarn using npm, run the following command: |
||||
|
|
||||
|
```bash |
||||
|
npm install --global yarn |
||||
|
``` |
||||
|
|
||||
|
## Docker Engine or Docker Desktop |
||||
|
|
||||
|
ABP's [startup solution templates](../solution-templates/index.md) use Docker to run infrastructure services (e.g. Redis, RabbitMQ) required by your application. You can install Docker Engine or Docker Desktop (recommended) on Windows, macOS and Linux. |
||||
|
|
||||
|
* [Docker Desktop](https://www.docker.com/products/docker-desktop/) (recommended) |
||||
|
* [Docker Engine](https://docs.docker.com/engine/install/) |
||||
|
|
||||
|
### Is Docker Engine or Docker Desktop Free? |
||||
|
|
||||
|
Docker Engine is an open-source and free containerization technology for building and containerizing your applications. [`Docker Engine` follows the Apache License 2.0](https://docs.docker.com/engine/#licensing). |
||||
|
|
||||
|
Docker Desktop is free [for small businesses (fewer than 250 employees and less than $10 million in annual revenue), personal use, education, and non-commercial open-source projects](https://docs.docker.com/subscription/desktop-license/). |
||||
|
|
||||
|
## PowerShell |
||||
|
|
||||
|
ABP startup solution templates and tools use some PowerShell scripts (`*.ps1`) to perform certain tasks. You can refer to the [PowerShell documentation](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell) for guidance on how to install PowerShell on Windows, macOS, and Linux. |
||||
|
|
||||
|
* [Install PowerShell on Windows](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows) |
||||
|
* [Install PowerShell on macOS](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-macos) |
||||
|
* [Install PowerShell on Linux](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux) |
||||
Loading…
Reference in new issue