From 9ae08880dffd0274518b3e38bccb5923bda31ab5 Mon Sep 17 00:00:00 2001 From: maliming Date: Fri, 20 Dec 2024 14:05:12 +0800 Subject: [PATCH] Revise `Pre-Requirements` document. Resolve #21686 --- docs/en/get-started/pre-requirements.md | 36 +++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 300c26a94f..d761e8b8bd 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -2,6 +2,13 @@ This document will guide you through preparing your development environment for ABP based application development. +> The prerequisites mentioned in this document are not all necessary. It based on your project type. + +* You don't need to install the EF Core CLI if your application uses MongoDB instead of EF Core. +* You don't need to use Redis(distributed cache) if your application has only one instance. See [When to Use a Distributed Cache Server](../kb/when-to-use-a-distributed-cache-server.md). +* You don't need to install Helm, NGINX Ingress, or mkcert if you are developing a non-microservice application. +* The `README.md` file in the solution will contain specific requirements for the current solution. Please refer to the `README.md` file of the solution. + ## IDE You need to use an IDE that supports .NET development. The following IDEs are the most popular ones for .NET development. @@ -70,3 +77,32 @@ ABP startup solution templates and tools use some PowerShell scripts (`*.ps1`) t * [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) + +## MicroService Solution + +The following tools are only required to develop ABP's [microservice solution](../solution-templates/microservice/index.md) + +### Helm + +[Helm](https://helm.sh/) is a package manager for Kubernetes. You can install Helm by following the [Helm installation guide](https://helm.sh/docs/intro/install/). + +See [Helm Deployment on Local Kubernetes Cluster](../solution-templates/microservice/helm-charts-and-kubernetes.md) for more information. + +### NGINX Ingress or NGINX Ingress using Helm + +[NGINX Ingress](https://kubernetes.github.io/ingress-nginx/deploy/) is an Ingress controller for Kubernetes. You can install NGINX Ingress by following the [NGINX Ingress installation guide](https://kubernetes.github.io/ingress-nginx/deploy/). + +If you are using Helm, you can install NGINX Ingress using the following commands: +```cs +helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx +helm repo update +helm upgrade --install --version=4.0.19 ingress-nginx ingress-nginx/ingress-nginx +``` + +### mkcert + +Use mkcert to generate trusted certificates for local development. You can install mkcert by following the [official mkcert installation guide](https://github.com/FiloSottile/mkcert#installation). + +### Docker Engine or Docker Desktop + +Docker is required to run the infrastructure services required by your application. You can install Docker Engine or Docker Desktop by following the above instructions.