From 775b874ee97f45eff927cd9b0bba8bc0cc73bf94 Mon Sep 17 00:00:00 2001 From: maliming Date: Thu, 19 Dec 2024 11:49:07 +0800 Subject: [PATCH 1/6] Added `Pre-Requirements` document. Resolve #21667 --- docs/en/docs-nav.json | 4 + docs/en/get-started/index.md | 2 + docs/en/get-started/pre-requirements.md | 128 ++++++++++++++++++++++++ 3 files changed, 134 insertions(+) create mode 100644 docs/en/get-started/pre-requirements.md diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index f29fa7f752..baa51d7f82 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -7,6 +7,10 @@ "text": "Overview", "path": "get-started" }, + { + "text": "Pre-Requirements", + "path": "get-started/pre-requirements.md" + }, { "text": "Single Layer Web Application", "path": "get-started/single-layer-web-application.md" diff --git a/docs/en/get-started/index.md b/docs/en/get-started/index.md index 6ffbfe548f..41baab424d 100644 --- a/docs/en/get-started/index.md +++ b/docs/en/get-started/index.md @@ -2,6 +2,8 @@ Great that you've decided to create a new application with ABP. ABP provides multiple startup templates for different needs. Each startup template is a fine-tuned and production-ready .NET solution that you can immediately start to develop your application based on it. +Before you start, You can check the [Pre-requirements](pre-requirements.md) to ensure you have all the necessary tools and environments installed. + Please select one of the following documents best fits for your application: - **[Single-Layer Solution](single-layer-web-application.md)**: Creates a single-project solution. Recommended for building an application with a **simpler and easy to understand** architecture. diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md new file mode 100644 index 0000000000..80c76834cc --- /dev/null +++ b/docs/en/get-started/pre-requirements.md @@ -0,0 +1,128 @@ +# Prerequisites for Developing an ABP Project + +Projects using the `ABP framework` require several common tools and environments. This document will guide you through preparing these tools and environments. + +## Visual Studio + +`Visual Studio` is Microsoft's IDE and is the preferred tool for developing `ABP` projects. The latest `ABP 9.0` is based on `.NET 9`, so `Visual Studio 2022` is the best choice. +You can download `Visual Studio 2022` from the [Visual Studio official website](https://visualstudio.microsoft.com/). You can also use the [free Community version of `Visual Studio 2022`](https://visualstudio.microsoft.com/free-developer-offers/). + +## JetBrains Rider + +`JetBrains Rider` is a cross-platform IDE and is also a preferred tool for developing ABP projects. You can download `JetBrains Rider` from the [JetBrains official website](https://www.jetbrains.com/rider/download). It supports `Windows`, `macOS`, and `Linux`. We recommend using the latest version or `>=2024.3` to support `.NET 9.0`. + +> [`JetBrains Rider` 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 9.0 SDK + +`ABP 9.0` is based on `.NET 9.0`, so you need to install the `.NET 9.0 SDK`. You can download the `.NET 9.0 SDK` from the [.NET official website](https://dotnet.microsoft.com/en-us/download/dotnet/9.0). + +> Installing `Visual Studio 2022` or `JetBrains Rider` may automatically install the `.NET 9.0 SDK`. You can run the `dotnet --list-sdks` command to check if the `.NET 9.0 SDK` is installed. + +### EF Core CLI + +If you are using `Entity Framework Core`, 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 --version 9.0.0 +``` + +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 --version 9.0.0 +``` + +### ABP CLI + +[ABP CLI](https://abp.io/cli) is a command line tool to perform common operations for ABP based solutions. Create new solutions, upgrade existing solutions, add modules, install packages, bundle your resources and much more… + +You can install `ABP CLI` by running the following command: + +```bash +dotnet tool install -g Volo.Abp.Studio.Cli +``` + +If you have already installed the `ABP CLI`, you can update it by running the following command: + +```bash +dotnet tool update -g Volo.Abp.Studio.Cli +``` + +## 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 [Node.js official 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 +``` + +## Redis + +### Why Redis is Needed + +For any application, if there are multiple instances, they should use `Redis(Distributed Cache)`. Otherwise, each instance will have its own internal memory cache for the same data, and there will be no way to invalidate that data. + +> [Why do we need to install `Redis`? When is it used?](https://abp.io/support/questions/6344/Why-do-we-need-to-install-Redis-When-is-it-used-Why-Redis-is-needed#answer-3a0f798f-8034-8ac8-c819-2103080bec13) + +### Installing Redis + +#### Windows + +`Redis` is not officially supported on `Windows`. However, you can refer to the [Redis documentation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-windows/) to install `Redis` on Windows for development purposes. + +> We recommend using Docker to install `Redis` on `Windows`. You can refer to the `Redis in Docker` section below. + +#### macOS and Linux + +Installing `Redis` on `macOS` and `Linux` is relatively simple. Please refer to: + +* Install `Redis` on `macOS`: [https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os/](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os/) +* Install `Redis` on `Linux`: [https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux) + +#### Redis in Docker + +We recommend using Docker to install and run your `Redis` server container, as it is the simplest way. You can run the following command to start the `Redis` container: + +```bash +docker run -p 6379:6379 --name RedisServer -d redis +``` + +With this single command, you can start a `Redis` server locally. After that, you can access `Redis` via `localhost:6379` or `127.0.0.1:6379`. + +In the following sections, we will discuss how to install `Docker Engine` or `Docker Desktop`. + +#### Is Redis Free? + +The way we install and use `Redis` through the above method is free. It is the `Redis Community Edition`. The `Redis Community Edition` is freely available to the `Redis` community and our customers, and developers will continue to enjoy the freedom to use `Redis` under [dual licensing](https://redis.io/blog/announcing-redis-community-edition-and-redis-stack-74/). + +## Docker Engine & Docker Desktop + +The `ABP` microservices project uses `Docker` to manage the infrastructure services required for various microservices. You can install `Docker Engine` or `Docker Desktop` on `Windows`, `macOS`, and `Linux`. + +* Install `Docker Engine`: [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) +* Install `Docker Desktop` on `macOS`: [https://docs.docker.com/desktop/setup/install/mac-install/](https://docs.docker.com/desktop/setup/install/mac-install/) +* Install `Docker Desktop` on `Windows`: [https://docs.docker.com/desktop/setup/install/windows-install/](https://docs.docker.com/desktop/setup/install/windows-install/) +* Install `Docker Desktop` on `Linux`: [https://docs.docker.com/desktop/setup/install/linux/](https://docs.docker.com/desktop/setup/install/linux/) + +### Is Docker Engine or Docker Desktop Free? + +`Docker Engine` is an open-source 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 projects may 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](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](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](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux) + +## Summary + +These are the tools and environments needed to develop `ABP` projects. You can install these tools and environments based on your needs. If you have any questions, you can seek help in the [ABP GitHub repository](https://github.com/abpframework/abp). From 8405dbd783de6e03141f8ffeb027571cdbd00178 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Thu, 19 Dec 2024 15:26:56 +0300 Subject: [PATCH 2/6] Update pre-requirements.md --- docs/en/get-started/pre-requirements.md | 53 ++++++++++--------------- 1 file changed, 21 insertions(+), 32 deletions(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 80c76834cc..4941b82509 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -1,61 +1,50 @@ -# Prerequisites for Developing an ABP Project +# Prerequisites for Developing ABP Projects -Projects using the `ABP framework` require several common tools and environments. This document will guide you through preparing these tools and environments. +This document will guide you through preparing your development environment for ABP based project development. -## Visual Studio +## IDE -`Visual Studio` is Microsoft's IDE and is the preferred tool for developing `ABP` projects. The latest `ABP 9.0` is based on `.NET 9`, so `Visual Studio 2022` is the best choice. -You can download `Visual Studio 2022` from the [Visual Studio official website](https://visualstudio.microsoft.com/). You can also use the [free Community version of `Visual Studio 2022`](https://visualstudio.microsoft.com/free-developer-offers/). +You need to use an IDE that supports .NET development. The following IDEs are the most popular ones for .NET development. -## JetBrains Rider +### Visual Studio -`JetBrains Rider` is a cross-platform IDE and is also a preferred tool for developing ABP projects. You can download `JetBrains Rider` from the [JetBrains official website](https://www.jetbrains.com/rider/download). It supports `Windows`, `macOS`, and `Linux`. We recommend using the latest version or `>=2024.3` to support `.NET 9.0`. +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. -> [`JetBrains Rider` is free for non-commercial use](https://blog.jetbrains.com/blog/2024/10/24/webstorm-and-rider-are-now-free-for-non-commercial-use/) +### Visual Studio Code -## .NET 9.0 SDK +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). -`ABP 9.0` is based on `.NET 9.0`, so you need to install the `.NET 9.0 SDK`. You can download the `.NET 9.0 SDK` from the [.NET official website](https://dotnet.microsoft.com/en-us/download/dotnet/9.0). +### JetBrains Rider -> Installing `Visual Studio 2022` or `JetBrains Rider` may automatically install the `.NET 9.0 SDK`. You can run the `dotnet --list-sdks` command to check if the `.NET 9.0 SDK` is installed. +[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/)**. -### EF Core CLI - -If you are using `Entity Framework Core`, 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: +## .NET SDK -```bash -dotnet tool install --global dotnet-ef --version 9.0.0 -``` +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). -If you have already installed the `EF Core CLI`, you can update it by running the following command: +> Installing Visual Studio or JetBrains Rider may automatically install the .NET SDK. -```bash -dotnet tool update --global dotnet-ef --version 9.0.0 -``` - -### ABP CLI - -[ABP CLI](https://abp.io/cli) is a command line tool to perform common operations for ABP based solutions. Create new solutions, upgrade existing solutions, add modules, install packages, bundle your resources and much more… +### EF Core CLI -You can install `ABP CLI` by running the following command: +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 -g Volo.Abp.Studio.Cli +dotnet tool install --global dotnet-ef ``` -If you have already installed the `ABP CLI`, you can update it by running the following command: +If you have already installed the `EF Core CLI`, you can update it by running the following command: ```bash -dotnet tool update -g Volo.Abp.Studio.Cli +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 [Node.js official website](https://nodejs.org/). We recommend installing version v20.11+. +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`). +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: +To install Yarn using npm, run the following command: ```bash npm install --global yarn From 773203f64bd00995fbe970f665744611d2d68829 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Thu, 19 Dec 2024 15:35:14 +0300 Subject: [PATCH 3/6] Revised the pre-requirements document --- docs/en/get-started/pre-requirements.md | 65 ++++--------------------- docs/en/solution-templates/index.md | 2 +- 2 files changed, 11 insertions(+), 56 deletions(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 4941b82509..48cb9d0804 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -50,68 +50,23 @@ To install Yarn using npm, run the following command: npm install --global yarn ``` -## Redis +## Docker Engine or Docker Desktop -### Why Redis is Needed +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. -For any application, if there are multiple instances, they should use `Redis(Distributed Cache)`. Otherwise, each instance will have its own internal memory cache for the same data, and there will be no way to invalidate that data. - -> [Why do we need to install `Redis`? When is it used?](https://abp.io/support/questions/6344/Why-do-we-need-to-install-Redis-When-is-it-used-Why-Redis-is-needed#answer-3a0f798f-8034-8ac8-c819-2103080bec13) - -### Installing Redis - -#### Windows - -`Redis` is not officially supported on `Windows`. However, you can refer to the [Redis documentation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-windows/) to install `Redis` on Windows for development purposes. - -> We recommend using Docker to install `Redis` on `Windows`. You can refer to the `Redis in Docker` section below. - -#### macOS and Linux - -Installing `Redis` on `macOS` and `Linux` is relatively simple. Please refer to: - -* Install `Redis` on `macOS`: [https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os/](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os/) -* Install `Redis` on `Linux`: [https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux) - -#### Redis in Docker - -We recommend using Docker to install and run your `Redis` server container, as it is the simplest way. You can run the following command to start the `Redis` container: - -```bash -docker run -p 6379:6379 --name RedisServer -d redis -``` - -With this single command, you can start a `Redis` server locally. After that, you can access `Redis` via `localhost:6379` or `127.0.0.1:6379`. - -In the following sections, we will discuss how to install `Docker Engine` or `Docker Desktop`. - -#### Is Redis Free? - -The way we install and use `Redis` through the above method is free. It is the `Redis Community Edition`. The `Redis Community Edition` is freely available to the `Redis` community and our customers, and developers will continue to enjoy the freedom to use `Redis` under [dual licensing](https://redis.io/blog/announcing-redis-community-edition-and-redis-stack-74/). - -## Docker Engine & Docker Desktop - -The `ABP` microservices project uses `Docker` to manage the infrastructure services required for various microservices. You can install `Docker Engine` or `Docker Desktop` on `Windows`, `macOS`, and `Linux`. - -* Install `Docker Engine`: [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) -* Install `Docker Desktop` on `macOS`: [https://docs.docker.com/desktop/setup/install/mac-install/](https://docs.docker.com/desktop/setup/install/mac-install/) -* Install `Docker Desktop` on `Windows`: [https://docs.docker.com/desktop/setup/install/windows-install/](https://docs.docker.com/desktop/setup/install/windows-install/) -* Install `Docker Desktop` on `Linux`: [https://docs.docker.com/desktop/setup/install/linux/](https://docs.docker.com/desktop/setup/install/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 containerization technology for building and containerizing your applications. [`Docker Engine` follows the Apache License 2.0](https://docs.docker.com/engine/#licensing). +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/). +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 projects may 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](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](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](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux) - -## Summary +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. -These are the tools and environments needed to develop `ABP` projects. You can install these tools and environments based on your needs. If you have any questions, you can seek help in the [ABP GitHub repository](https://github.com/abpframework/abp). +* [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) diff --git a/docs/en/solution-templates/index.md b/docs/en/solution-templates/index.md index b5bf59688d..739dbc453e 100644 --- a/docs/en/solution-templates/index.md +++ b/docs/en/solution-templates/index.md @@ -1,4 +1,4 @@ -# Solution Templates +# Startup Solution Templates ABP provides pre-architected and production-ready templates to jump start a new solution. From 75023a9c94b0d1a00dae4fe5974960f0c496b036 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alper=20Ebi=C3=A7o=C4=9Flu?= <9526587+ebicoglu@users.noreply.github.com> Date: Thu, 19 Dec 2024 17:06:55 +0300 Subject: [PATCH 4/6] Update pre-requirements.md --- docs/en/get-started/pre-requirements.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 48cb9d0804..046123d9e4 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -1,6 +1,6 @@ # Prerequisites for Developing ABP Projects -This document will guide you through preparing your development environment for ABP based project development. +This document will guide you through preparing your development environment for ABP-based project development. ## IDE @@ -8,7 +8,7 @@ You need to use an IDE that supports .NET development. The following IDEs are th ### 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 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 @@ -20,7 +20,7 @@ Visual Studio Code is a **free and cross-platform** lightweight code editor that ## .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). +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/). > Installing Visual Studio or JetBrains Rider may automatically install the .NET SDK. @@ -42,9 +42,9 @@ dotnet tool update --global dotnet-ef 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+). +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: +To install Yarn using NPM, run the following command: ```bash npm install --global yarn @@ -59,9 +59,9 @@ ABP's [startup solution templates](../solution-templates/index.md) use Docker to ### 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 Engine](https://docs.docker.com/engine/#licensing) is an open-source and free containerization technology for building and containerizing your applications. Docker Engine is licensed under the Apache License 2.0. -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/). +[Docker Desktop](https://docs.docker.com/subscription/desktop-license/) is free for individuals and small businesses with fewer than 250 employees or less than $10 million in annual revenue, personal use, education, and non-commercial open-source projects. ## PowerShell From 4ff827e056ffd39b6729a6adaf49b2a73466c67a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Thu, 19 Dec 2024 17:10:41 +0300 Subject: [PATCH 5/6] Edit pre-requirements doc --- docs/en/get-started/index.md | 2 -- docs/en/get-started/layered-web-application.md | 8 +++----- docs/en/get-started/microservice.md | 10 ++++------ docs/en/get-started/pre-requirements.md | 4 ++-- docs/en/get-started/single-layer-web-application.md | 8 +++----- 5 files changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/en/get-started/index.md b/docs/en/get-started/index.md index 41baab424d..6ffbfe548f 100644 --- a/docs/en/get-started/index.md +++ b/docs/en/get-started/index.md @@ -2,8 +2,6 @@ Great that you've decided to create a new application with ABP. ABP provides multiple startup templates for different needs. Each startup template is a fine-tuned and production-ready .NET solution that you can immediately start to develop your application based on it. -Before you start, You can check the [Pre-requirements](pre-requirements.md) to ensure you have all the necessary tools and environments installed. - Please select one of the following documents best fits for your application: - **[Single-Layer Solution](single-layer-web-application.md)**: Creates a single-project solution. Recommended for building an application with a **simpler and easy to understand** architecture. diff --git a/docs/en/get-started/layered-web-application.md b/docs/en/get-started/layered-web-application.md index 44d3780cd3..bb2e6835dd 100644 --- a/docs/en/get-started/layered-web-application.md +++ b/docs/en/get-started/layered-web-application.md @@ -13,11 +13,7 @@ In this quick start guide, you will learn how to create and run a layered (and p ## 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: +First things first! Let's setup your development environment before creating the first project. The following tools should be installed on your development machine: * [Visual Studio 2022](https://visualstudio.microsoft.com/) or another IDE that supports [.NET 9.0+](https://dotnet.microsoft.com/download/dotnet) development. [1](#f-editor) * [.NET 9.0+](https://dotnet.microsoft.com/en-us/download/dotnet) @@ -35,6 +31,8 @@ The following tools should be installed on your development machine: {{ end }} +> Check the [Pre-requirements document](pre-requirements.md) for more detailed information about these tools. + ## Creating a New Solution > This document uses [ABP Studio](../studio/index.md) to create new ABP solutions. **ABP Studio** is in the beta version now. If you have any issues, you can use the [ABP CLI](../cli/index.md) to create new solutions. You can also use the [getting started page](https://abp.io/get-started) to easily build ABP CLI commands for new project creations. diff --git a/docs/en/get-started/microservice.md b/docs/en/get-started/microservice.md index dfa075fae9..5a732dc508 100644 --- a/docs/en/get-started/microservice.md +++ b/docs/en/get-started/microservice.md @@ -6,20 +6,18 @@ In this quick start guide, you will learn how to create and run a microservice s ## 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: +First things first! Let's setup your development environment before creating the first project. The following tools should be installed on your development machine: * [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or another IDE that supports .NET development * [.NET 9.0+](https://dotnet.microsoft.com/en-us/download/dotnet) * [Node v22.11+](https://nodejs.org/) * [Docker Desktop with Kubernetes](https://www.docker.com/products/docker-desktop/) -* [helm](https://helm.sh/docs/intro/install/) +* [Helm](https://helm.sh/docs/intro/install/) * [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/) * [mkcert](https://github.com/FiloSottile/mkcert#installation) +> Check the [Pre-requirements document](pre-requirements.md) for more detailed information about these tools. + ## Creating a New Solution > 🛈 This document uses [ABP Studio](../studio/index.md) to create new ABP solutions. **ABP Studio** is in the beta version now. If you have any issues, you can use the [ABP CLI](../cli/index.md) to create new solutions. You can also use the [getting started page](https://abp.io/get-started) to easily build ABP CLI commands for new project creations. diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 48cb9d0804..300c26a94f 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -1,6 +1,6 @@ -# Prerequisites for Developing ABP Projects +# Prerequisites for Developing ABP Applications -This document will guide you through preparing your development environment for ABP based project development. +This document will guide you through preparing your development environment for ABP based application development. ## IDE diff --git a/docs/en/get-started/single-layer-web-application.md b/docs/en/get-started/single-layer-web-application.md index e87f8b845c..4e943876ef 100644 --- a/docs/en/get-started/single-layer-web-application.md +++ b/docs/en/get-started/single-layer-web-application.md @@ -12,11 +12,7 @@ In this quick start guide, you will learn how to create and run a single layer w ## 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: +First things first! Let's setup your development environment before creating the first project. The following tools should be installed on your development machine: * [Visual Studio 2022](https://visualstudio.microsoft.com/) or another IDE that supports [.NET 9.0+](https://dotnet.microsoft.com/download/dotnet) development. [1](#f-editor) * [.NET 9.0+](https://dotnet.microsoft.com/en-us/download/dotnet) @@ -33,6 +29,8 @@ The following tools should be installed on your development machine: {{ end }} +> Check the [Pre-requirements document](pre-requirements.md) for more detailed information about these tools. + ## Creating a New Solution > 🛈 This document uses [ABP Studio](../studio/index.md) to create new ABP solutions. **ABP Studio** is in the beta version now. If you have any issues, you can use the [ABP CLI](../cli/index.md) to create new solutions. You can also use the [getting started page](https://abp.io/get-started) to easily build ABP CLI commands for new project creations. From 656536517d9005e11c09717e317b9f4214c0dbdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Thu, 19 Dec 2024 17:14:31 +0300 Subject: [PATCH 6/6] Move pre-requirements in the menu --- docs/en/docs-nav.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index baa51d7f82..887e849f35 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -7,10 +7,6 @@ "text": "Overview", "path": "get-started" }, - { - "text": "Pre-Requirements", - "path": "get-started/pre-requirements.md" - }, { "text": "Single Layer Web Application", "path": "get-started/single-layer-web-application.md" @@ -43,6 +39,10 @@ "path": "get-started/console.md" } ] + }, + { + "text": "Pre-Requirements", + "path": "get-started/pre-requirements.md" } ] },