diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index f29fa7f752..887e849f35 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -39,6 +39,10 @@ "path": "get-started/console.md" } ] + }, + { + "text": "Pre-Requirements", + "path": "get-started/pre-requirements.md" } ] }, 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 new file mode 100644 index 0000000000..300c26a94f --- /dev/null +++ b/docs/en/get-started/pre-requirements.md @@ -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) 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. 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.