Browse Source

Merge pull request #23129 from abpframework/yarn-prerequirement-warning-doc

Remove Yarn dependency warnings from the documentation
pull/23142/head
Halil İbrahim Kalkan 11 months ago
committed by GitHub
parent
commit
018e8336fc
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 4
      docs/en/framework/real-time/signalr.md
  2. 2
      docs/en/framework/ui/mvc-razor-pages/basic-theme.md
  3. 11
      docs/en/framework/ui/mvc-razor-pages/client-side-package-management.md
  4. 2
      docs/en/get-started/layered-web-application.md
  5. 2
      docs/en/get-started/microservice.md
  6. 8
      docs/en/get-started/pre-requirements.md
  7. 2
      docs/en/get-started/single-layer-web-application.md
  8. 2
      docs/en/tutorials/book-store/part-01.md
  9. 2
      docs/en/tutorials/todo/layered/index.md
  10. 2
      docs/en/tutorials/todo/single-layer/index.md

4
docs/en/framework/real-time/signalr.md

@ -55,11 +55,9 @@ Client side installation depends on your UI framework / client type.
Run the following command in the root folder of your web project:
```bash
yarn add @abp/signalr
abp add-package @abp/signalr
```
> This requires to [install yarn](https://yarnpkg.com/) if you haven't install before.
This will add the `@abp/signalr` to the dependencies in the `package.json` of your project:
```json

2
docs/en/framework/ui/mvc-razor-pages/basic-theme.md

@ -14,7 +14,7 @@ If you need to manually this theme, follow the steps below:
* Install the [Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic](https://www.nuget.org/packages/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic) NuGet package to your web project.
* Add `AbpAspNetCoreMvcUiBasicThemeModule` into the `[DependsOn(...)]` attribute for your [module class](../../architecture/modularity/basics.md) in the web project.
* Install the [@abp/aspnetcore.mvc.ui.theme.basic](https://www.npmjs.com/package/@abp/aspnetcore.mvc.ui.theme.basic) NPM package to your web project (e.g. `npm install @abp/aspnetcore.mvc.ui.theme.basic` or `yarn add @abp/aspnetcore.mvc.ui.theme.basic`).
* Install the [@abp/aspnetcore.mvc.ui.theme.basic](https://www.npmjs.com/package/@abp/aspnetcore.mvc.ui.theme.basic) NPM package to your web project (e.g. `abp add-package @abp/aspnetcore.mvc.ui.theme.basic`).
* Run `abp install-libs` command in a command line terminal in the web project's folder.
## Layouts

11
docs/en/framework/ui/mvc-razor-pages/client-side-package-management.md

@ -3,9 +3,8 @@
ABP can work with any type of client side package management systems. You can even decide to use no package management system and manage your dependencies manually.
However, ABP works best with **NPM/Yarn**. By default, built-in modules are configured to work with NPM/Yarn.
However, ABP works best with **NPM**. By default, built-in modules are configured to work with NPM.
Finally, we suggest the [**Yarn**](https://classic.yarnpkg.com/) over the NPM since it's faster, stable and also compatible with the NPM.
### @ABP NPM Packages
@ -35,14 +34,12 @@ It's suggested to depend on a standard package instead of directly depending on
#### Package Installation
After depending on a NPM package, all you should do is to run the **yarn** command from the command line to install all the packages and their dependencies:
After depending on a NPM package, you should run the **abp install-libs** command from the command line to install all the packages and their dependencies, and copy the required resources to the wwwroot/libs folder:
```bash
yarn
abp install-libs
```
Alternatively, you can use `npm install` but [Yarn v1.22+ (not v2)](https://classic.yarnpkg.com/en/docs/install) is suggested as mentioned before.
#### Package Contribution
If you need a third-party NPM package that is not in the standard set of packages, you can create a Pull Request on the Github [repository](https://github.com/volosoft/abp). A pull request that follows these rules is accepted:
@ -57,7 +54,7 @@ See current standard packages for examples.
### Mapping The Library Resources
Using NPM packages and NPM/Yarn tool is the de facto standard for client side libraries. NPM/Yarn tool creates a **node_modules** folder in the root folder of your web project.
Using NPM packages and NPM tool is the de facto standard for client side libraries. NPM tool creates a **node_modules** folder in the root folder of your web project.
Next challenge is copying needed resources (js, css, img... files) from the `node_modules` into a folder inside the **wwwroot** folder to make it accessible to the clients/browsers.

2
docs/en/get-started/layered-web-application.md

@ -17,7 +17,7 @@ First things first! Let's setup your development environment before creating the
* [Visual Studio 2022](https://visualstudio.microsoft.com/) or another IDE that supports [.NET 9.0+](https://dotnet.microsoft.com/download/dotnet) development.
* [.NET 9.0+](https://dotnet.microsoft.com/en-us/download/dotnet){{ if UI != "Blazor" }}
* [Node v22.11+](https://nodejs.org/)
* [Node v22.11+](https://nodejs.org/){{ end }}{{ if UI == "NG" }}
* [Yarn v1.22+ (not v2+)](https://classic.yarnpkg.com/en/docs/install) or npm v10+ (already installed with Node){{ end }}
* [Docker Desktop](https://www.docker.com/products/docker-desktop/)

2
docs/en/get-started/microservice.md

@ -11,7 +11,7 @@ First things first! Let's setup your development environment before creating the
* [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/)
* [Yarn v1.22+ (not v2+)](https://classic.yarnpkg.com/en/docs/install) or npm v10+ (already installed with Node)
* [Yarn v1.22+ (not v2+)](https://classic.yarnpkg.com/en/docs/install) or npm v10+ (already installed with Node), **This is required for the Angular applications.**
* [Docker Desktop (with Kubernetes enabled)](https://www.docker.com/products/docker-desktop/)
* [Helm](https://helm.sh/docs/intro/install/)
* [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/)

8
docs/en/get-started/pre-requirements.md

@ -47,11 +47,13 @@ If you have already installed the `EF Core CLI`, you can update it by running th
dotnet tool update --global dotnet-ef
```
## Node.js and Yarn
## Node.js
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+.
ABP projects include some frontend resource packages, so you need to install Node.js/NPM 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+).
## Yarn (Required Only for Angular Projects)
ABP Angular projects use Yarn as the package manager to manage frontend dependencies and run build tasks, 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:

2
docs/en/get-started/single-layer-web-application.md

@ -16,7 +16,7 @@ First things first! Let's setup your development environment before creating the
* [Visual Studio 2022](https://visualstudio.microsoft.com/) or another IDE that supports [.NET 9.0+](https://dotnet.microsoft.com/download/dotnet) development.
* [.NET 9.0+](https://dotnet.microsoft.com/en-us/download/dotnet){{ if UI != "Blazor" }}
* [Node v22.11+](https://nodejs.org/)
* [Node v22.11+](https://nodejs.org/){{ end }}{{ if UI == "NG" }}
* [Yarn v1.22+ (not v2+)](https://classic.yarnpkg.com/en/docs/install) or npm v10+ (already installed with Node){{ end }}
> Check the [Pre-requirements document](pre-requirements.md) for more detailed information about these tools.

2
docs/en/tutorials/book-store/part-01.md

@ -34,8 +34,6 @@ For such cases, run the `abp install-libs` command on the root directory of your
abp install-libs
```
> We suggest you install [Yarn v1.22+ (not v2)](https://classic.yarnpkg.com/en/docs/install) to prevent possible package inconsistencies, if you haven't installed it yet.
## Create the Book Entity
**Domain layer** in the startup template is separated into two projects:

2
docs/en/tutorials/todo/layered/index.md

@ -111,8 +111,6 @@ For such cases, run the `abp install-libs` command on the root directory of your
abp install-libs
````
> We suggest you install [Yarn v1.22+ (not v2)](https://classic.yarnpkg.com/en/docs/install) to prevent possible package inconsistencies, if you haven't installed it yet.
### Run the Application
{{if UI=="MVC" || UI=="BlazorServer" || UI=="BlazorWebApp"}}

2
docs/en/tutorials/todo/single-layer/index.md

@ -113,8 +113,6 @@ Run the `abp install-libs` command on the root directory of your solution to ins
abp install-libs
```
> We suggest you install [Yarn v1.22+ (not v2)](https://classic.yarnpkg.com/en/docs/install) to prevent possible package inconsistencies, if you haven't installed it yet.
### Run the Application
{{if UI=="MVC" || UI=="BlazorServer"}}

Loading…
Cancel
Save