Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/en/Deployment-Angular-Publish-Azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@ Select "**your-host-app-service-name**" and click "**OK**", then click "**Publis

Here are the quick steps to publish the **AngularUI** to the Azure

- Run the `yarn` command to restore packages
- Run the `npm run publish` command to publish Angular app.
- Run the `pnpm install` command to restore packages
- Run the `pnpm run publish` command to publish Angular app.
- Copy the web.config file that is placed in **angular** folder to **dist** folder
- Configure the **angular/dist/assets/appconfig.json** with your production URLs.
- Upload all files under "angular/dist" folder to your website on Azure created for the Angular UI.

### Prepare The Publish Folder

Run the `yarn` command to restore packages and run the `npm run publish` to publish the Angular app.
Run the `pnpm install` command to restore packages and run the `pnpm run publish` to publish the Angular app.

### Copy the web.config

Expand Down
6 changes: 3 additions & 3 deletions docs/en/Deployment-Angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

ASP.NET Zero depends on [angular-cli](https://cli.angular.io/) for development & deployment. It uses angular-cli commands to build and publish its Angular client application. ASP.NET Zero also minifies and bundles some assets (JS and CSS files) using [gulp](https://gulpjs.com/) before publishing the Angular client application since those assets are loaded dynamically at runtime. In order to publish the Angular client application below commands must be run respectively.

1. run ```yarn``` command in the root directory of Angular project.
2. run ```npm run publish``` command in the root directory of Angular project.
1. run ```pnpm install``` command in the root directory of Angular project.
2. run ```pnpm run publish``` command in the root directory of Angular project.

In the Web.Host project, run ```npm run create-bundles``` to bundle and minify JS and CSS files before final deployment.
In the Web.Host project, run ```pnpm run create-bundles``` to bundle and minify JS and CSS files before final deployment.

ASP.NET Zero also provides a merged solution for ASP.NET Core & Angular version. In that solution, Angular client side application is included in the server side Host project. Those two applications, server side API project and Angular client side application, can be published at once and can be hosted together under the same website.

Expand Down
8 changes: 4 additions & 4 deletions docs/en/Deployment-Mvc-Core-Azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ On Azure portal, go to SQL databases menu and create a new empty database. If yo

Here are the quick steps to publish the **Web.Mvc Application** to the Azure.

- Run the ```yarn``` command in the root directory of MVC project.
- Run the `npm run build` to bundle and minify the js/css files
- Run the ```pnpm install``` command in the root directory of MVC project.
- Run the `pnpm run build` to bundle and minify the js/css files
- Run the migrations on the Azure
- Configure the **.Web.Mvc/appsettings.production.json**
- Publish the application to Azure

### Run the `npm run build`

First run the ```yarn``` command in the root directory of MVC project to install client side dependencies. Then, run the `npm run build` to bundle and minify the script and style files.
First run the ```pnpm install``` command in the root directory of MVC project to install client side dependencies. Then, run the `pnpm run build` to bundle and minify the script and style files.

### Run Migrations on The Azure

Expand Down Expand Up @@ -98,7 +98,7 @@ Since we migrated the database when deploying Admin application, we will not do

### NPM Packages

First run the ```yarn``` command in the root directory of MVC project to install client side dependencies. Then, run the `npm run build` to bundle and minify the script and style files.
First run the ```pnpm install``` command in the root directory of MVC project to install client side dependencies. Then, run the `pnpm run build` to bundle and minify the script and style files.

### Configure the appsettings.production.json

Expand Down
4 changes: 2 additions & 2 deletions docs/en/Deployment-React-Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ ASP.NET Zero solution has a **build folder** which contains scripts to **build &

* Node.js (LTS version recommended)
* Docker Desktop installed and running
* Packages installed (`yarn` or `npm install`)
* Packages installed (`pnpm install` or `npm install`)

## Building the React Application

Before creating a Docker image, build the React application:

```bash
yarn build
pnpm build
# or
npm run build
```
Expand Down
2 changes: 1 addition & 1 deletion docs/en/Deployment-React-Publish-Azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ This URL should point to your published Host API application.
Run the following commands to build the React application:

```bash
yarn && yarn build
pnpm install && pnpm build
# or
npm install && npm run build
```
Expand Down
2 changes: 1 addition & 1 deletion docs/en/Deployment-React-Publish-IIS.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The React application is built using Vite and can be deployed as static files to
VITE_API_BASE_URL=https://your-host-api-url
```

2. Run `yarn build` or `npm run build`. This command outputs the production build to the `dist` folder.
2. Run `pnpm build` or `npm run build`. This command outputs the production build to the `dist` folder.

3. Copy all files from the `dist` folder to your IIS website directory (for example: `C:\inetpub\wwwroot\reactwebsite`).

Expand Down
8 changes: 4 additions & 4 deletions docs/en/Deployment-React.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ ASP.NET Zero React UI is built using [Vite](https://vite.dev/) as the build tool

To build the React application for production, run the following commands in the root directory of the React project:

1. Run `yarn` or `npm install` to install dependencies.
2. Run `yarn build` or `npm run build` to create a production build.
1. Run `pnpm install` or `npm install` to install dependencies.
2. Run `pnpm build` or `npm run build` to create a production build.

The build output will be placed in the `dist/` folder, ready for deployment to any static file server.

Expand All @@ -29,7 +29,7 @@ ASP.NET Zero also provides a merged solution where the React client-side applica

To publish the merged solution:

1. Run `yarn build` or `npm run build` in the React project to build the client application.
1. Run `pnpm build` or `npm run build` in the React project to build the client application.
2. Run `dotnet publish -c Release` in the root directory of the `*.Host` project. See the [dotnet publish documentation](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish) for additional parameters.
3. When the publish is complete, ensure the React build output is copied to the `wwwroot` folder of the published Host application.

Expand All @@ -47,7 +47,7 @@ Vite automatically applies the following optimizations for production builds:
You can preview the production build locally by running:

```bash
yarn preview
pnpm preview
# or
npm run preview
```
Expand Down
2 changes: 1 addition & 1 deletion docs/en/Development-React-Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The React UI is a client-side application that can be run in two ways during dev
Run the React UI using the Vite development server:

```bash
yarn && yarn dev
pnpm install && pnpm dev
# or
npm install && npm run dev
```
Expand Down
8 changes: 4 additions & 4 deletions docs/en/Getting-Started-Angular-Merged.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Select **ASP.NET Core & Angular** as Project Type and fill other required fields

- [Visual Studio 2017 (v15.9.0+)](https://www.visualstudio.com) (for backend ASP.NET Core application)
- [Node.js 6.9+ with NPM 3.10+](https://nodejs.org/en/download/)
- [Yarn v1.x](https://classic.yarnpkg.com/lang/en/)
- [pnpm](https://pnpm.io/installation)

## ASP.NET Core Application

Expand Down Expand Up @@ -89,16 +89,16 @@ For example when you navigate **Swagger UI**, you will see following page:
Navigate to the root folder of ***.Web.Host** project, open a command line and run the following command to restore the packages:

```bash
yarn
pnpm install
```

Then, run the following command to create dynamic bundles *(This is only required for the first time when you download the project or when you update dynamic bundles)*:

```bash
npm run create-dynamic-bundles
pnpm run create-dynamic-bundles
```

We use [yarn v1.x](https://classic.yarnpkg.com/lang/en/) because NPM has some problems; It is slow and can not consistently resolve dependencies. Yarn solves those problems and it is compatible to NPM as well.
We use [pnpm](https://pnpm.io/) for fast, disk-efficient and deterministic dependency resolution. The pinned version is declared in `package.json` under the `packageManager` field, so [Corepack](https://nodejs.org/api/corepack.html) will activate the correct pnpm version automatically.

### Running The Application

Expand Down
8 changes: 4 additions & 4 deletions docs/en/Getting-Started-Angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you have selected this option, please follow [Getting Started](Getting-Starte

- [Visual Studio 2017 (v15.9.0+)](https://www.visualstudio.com) (for backend ASP.NET Core application)
- [Node.js 16.x+ with NPM 8.x+](https://nodejs.org/en/download/)
- [Yarn v1.x](https://classic.yarnpkg.com/lang/en/)
- [pnpm](https://pnpm.io/installation)

## ASP.NET Core Application

Expand Down Expand Up @@ -97,16 +97,16 @@ For example when you navigate **Swagger UI**, you will see following page:
Navigate to the **angular** folder, open a command line and run the following command to restore the packages:

```bash
yarn
pnpm install
```

Then, run the following command to create dynamic bundles *(This is only required for the first time when you download the project or when you update dynamic bundles)*:

```bash
npm run create-dynamic-bundles
pnpm run create-dynamic-bundles
```

We use [yarn v1.x](https://classic.yarnpkg.com/lang/en/) because NPM has some problems; It is slow and can not consistently resolve dependencies. Yarn solves those problems and it is compatible to NPM as well.
We use [pnpm](https://pnpm.io/) for fast, disk-efficient and deterministic dependency resolution. The pinned version is declared in `package.json` under the `packageManager` field, so [Corepack](https://nodejs.org/api/corepack.html) will activate the correct pnpm version automatically.

### Running The Application

Expand Down
8 changes: 4 additions & 4 deletions docs/en/Getting-Started-Core.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ Select **ASP.NET Core & jQuery** as Project Type and fill other required fields.

- [Visual Studio 2017 (v15.9.0+)](https://www.visualstudio.com)
- [Node.js 16.x+ with NPM 8.x+](https://nodejs.org/en/download/)
- [Yarn v1.x](https://classic.yarnpkg.com/lang/en/)
- [pnpm](https://pnpm.io/installation)

## Configure The Project

Before opening the solution, open a command prompt, navigate to root directory of **\*.Web.Mvc** project and run "**yarn**" command to install client side dependencies.
Before opening the solution, open a command prompt, navigate to root directory of **\*.Web.Mvc** project and run "**pnpm install**" command to install client side dependencies.

```bash
yarn
pnpm install
```

**Important Notice:** Installing client side npm dependencies using **yarn** before opening the solution will decrease project opening & building time dramatically.
**Important Notice:** Installing client side npm dependencies using **pnpm** before opening the solution will decrease project opening & building time dramatically.

Open the **\*.Web.sln** solution in **Visual Studio**. If you want to work on only MAUI project, open **\*.Maui.sln** solution. If you want to work on both MAUI and Web projects, open **\*.All.sln** solution.

Expand Down
6 changes: 3 additions & 3 deletions docs/en/Getting-Started-MacOSX.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Download an ASP.NET CORE & Angular project with .NET Core framework as described
- Visual Studio for Mac: [https://visualstudio.microsoft.com/vs/mac/](https://visualstudio.microsoft.com/vs/mac/)
- .Net core SDK: [https://www.microsoft.com/net/download/macos](https://www.microsoft.com/net/download/macos)

- Yarn v1.x [https://classic.yarnpkg.com/en/docs/install#mac-stable](https://classic.yarnpkg.com/en/docs/install#mac-stable)
- pnpm [https://pnpm.io/installation#using-a-standalone-script](https://pnpm.io/installation#using-a-standalone-script)
- NVM with node version 8.11.1+: [https://github.com/creationix/nvm](https://github.com/creationix/nvm)
- Angular-cli ([https://cli.angular.io/](https://cli.angular.io/))

## Restoring Packages

In the terminal, go to base_folder/angular and run the `yarn` command:
In the terminal, go to base_folder/angular and run the `pnpm install` command:

```bash
yarn
pnpm install
```

## Configuration & Build
Expand Down
16 changes: 6 additions & 10 deletions docs/en/Getting-Started-React.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Select **ASP.NET Core & React** as Project Type and fill other required fields.

- [Visual Studio 2022 (v17.10+)](https://www.visualstudio.com) (for backend ASP.NET Core application)
- [Node.js 18.x+ with NPM 8.x+](https://nodejs.org/en/download/)
- [Yarn v1.x](https://classic.yarnpkg.com/lang/en/)
- [pnpm](https://pnpm.io/installation)

## ASP.NET Core Application

Expand Down Expand Up @@ -88,24 +88,20 @@ For example when you navigate **Swagger UI**, you will see following page:

### Restore Packages

Navigate to the **react** folder, open a command line and run one of the following commands to restore the packages:
Navigate to the **react** folder, open a command line and run the following command to restore the packages:

```bash
yarn
# or
npm install
pnpm install
```

We recommend using [yarn v1.x](https://classic.yarnpkg.com/lang/en/) for faster and more consistent dependency resolution, but npm works as well.
We use [pnpm](https://pnpm.io/) for faster and more deterministic dependency resolution. The pinned version is declared in `package.json` under the `packageManager` field, so [Corepack](https://nodejs.org/api/corepack.html) will activate the correct pnpm version automatically. NPM also works if you prefer it (`npm install`).

### Running The Application

Run one of the following commands in the command line:
Run the following command in the command line:

```bash
yarn dev
# or
npm run dev
pnpm dev
```

Once the application compiled, you can browse <http://localhost:4200> in your browser.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/Infrastructure-Angular-Npm-Packages.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# NPM Packages

ASP.NET Zero solution supports both [Yarn v1.x](https://classic.yarnpkg.com/lang/en/) and [NPM](https://www.npmjs.com/) to obtain front end library dependencies (like Angular and Bootstrap). We suggest to use yarn because NPM has some problems, yarn solves those problems and it is compatible with NPM as well. You can easily add, update or remove packages on yarn's command line interface.
ASP.NET Zero solution uses [pnpm](https://pnpm.io/) (preferred) to obtain front end library dependencies (like Angular and Bootstrap). [NPM](https://www.npmjs.com/) is also supported. We suggest using pnpm because it is fast, disk-efficient, and deterministic. The pinned pnpm version is declared in `package.json` under the `packageManager` field, so [Corepack](https://nodejs.org/api/corepack.html) will activate the correct version automatically. You can easily add, update or remove packages on pnpm's command line interface.
6 changes: 3 additions & 3 deletions docs/en/Infrastructure-React-Bundling-Minifying-Compiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ASP.NET Zero uses [Vite](https://vitejs.dev/) to build the React application. Vi
During development, run the following command to start the Vite development server:

```bash
yarn dev
pnpm dev
# or
npm run dev
```
Expand All @@ -19,7 +19,7 @@ Vite provides fast Hot Module Replacement (HMR) and serves your assets without b
For production, run the following command:

```bash
yarn build
pnpm build
# or
npm run build
```
Expand All @@ -37,7 +37,7 @@ This command will:
To preview the production build locally before deployment, you can use:

```bash
yarn preview
pnpm preview
# or
npm run preview
```
Expand Down
16 changes: 8 additions & 8 deletions docs/en/Infrastructure-React-Npm-Packages.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Package Management

ASP.NET Zero React UI uses [Yarn](https://classic.yarnpkg.com/) or [NPM](https://www.npmjs.com/) to manage front-end library dependencies (like React and Ant Design). You can easily add, update, or remove packages using the command line interface.
ASP.NET Zero React UI uses [pnpm](https://pnpm.io/) (preferred) or [NPM](https://www.npmjs.com/) to manage front-end library dependencies (like React and Ant Design). The pinned pnpm version is declared in `package.json` under the `packageManager` field, so [Corepack](https://nodejs.org/api/corepack.html) will activate the correct version automatically. You can easily add, update, or remove packages using the command line interface.

## Common Commands

| Action | Yarn | NPM |
| Action | pnpm | NPM |
|--------|------|-----|
| Install all dependencies | `yarn` | `npm install` |
| Add a new package | `yarn add package-name` | `npm install package-name` |
| Add a dev dependency | `yarn add package-name --dev` | `npm install package-name --save-dev` |
| Update packages | `yarn upgrade` | `npm update` |
| Remove a package | `yarn remove package-name` | `npm uninstall package-name` |
| Install all dependencies | `pnpm install` | `npm install` |
| Add a new package | `pnpm add package-name` | `npm install package-name` |
| Add a dev dependency | `pnpm add -D package-name` | `npm install package-name --save-dev` |
| Update packages | `pnpm update` | `npm update` |
| Remove a package | `pnpm remove package-name` | `npm uninstall package-name` |

## Package.json

Dependencies are defined in [package.json](../package.json). After modifying dependencies, run `yarn` or `npm install` to update your `node_modules` folder.
Dependencies are defined in [package.json](../package.json). After modifying dependencies, run `pnpm install` or `npm install` to update your `node_modules` folder.
6 changes: 3 additions & 3 deletions docs/en/Infrastructure-React-Vite.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ASP.NET Zero React UI uses [Vite](https://vitejs.dev/) for development and produ
To run the application in development mode, open a terminal and run:

```bash
yarn dev
pnpm dev
# or
npm run dev
```
Expand All @@ -19,7 +19,7 @@ Once compiled and ready, you can open the application in your browser at <http:/
To create a production build:

```bash
yarn build
pnpm build
# or
npm run build
```
Expand All @@ -31,7 +31,7 @@ This creates an optimized build in the `dist/` folder.
To preview the production build locally:

```bash
yarn preview
pnpm preview
# or
npm run preview
```
Expand Down
4 changes: 2 additions & 2 deletions docs/en/Playwright-UI-Testing-Angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ ASP.NET Zero provides an infrastructure for UI tests using [Playwright](https://
You should have the following installed in your system:

- [Node.js](https://nodejs.org/en/) is the runtime. Please make sure you have v12+ (LTS recommended) in your system before you start.
- [Yarn v1.x](https://classic.yarnpkg.com/lang/en/)
- [pnpm](https://pnpm.io/installation)

After making sure these exist in your system, follow the steps below:

1. Open your terminal.
2. Navigate to the `ui-tests-playwright` folder of this project.
3. Run `yarn`.
3. Run `pnpm install`.

There are two parts of the project that requires your close attention.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/Playwright-UI-Testing-React.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ After making sure Node.js is installed, follow the steps below:

1. Open your terminal.
2. Navigate to the `ui-tests-playwright` folder of this project.
3. Run `yarn` or `npm install`.
3. Run `pnpm install` or `npm install`.

There are two parts of the project that requires your close attention.

Expand Down
Loading