Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace gulp usage with abp install-libs command in the documents #9872

Merged
merged 5 commits into from
Aug 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ namespace SignalRTieredDemo.Web
{
````

Also, we need to add [@abp/signalr](https://www.npmjs.com/package/@abp/signalr) npm package to package.json in ***.Web** project, then run **yarn** and **gulp** commands.
Also, we need to add [@abp/signalr](https://www.npmjs.com/package/@abp/signalr) npm package to package.json in ***.Web** project, then run **abp install-libs** command.

`````json
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,11 @@ module.exports = {
};
```

Open your `DevExtremeSample.Web` project folder with a command line and run the `gulp` command. This command will copy the needed library files into the ``/wwwroot/libs/devextreme/` folder.
Open your `DevExtremeSample.Web` project folder with a command line and run the `abp install-libs` command. This command will copy the needed library files into the `/wwwroot/libs/devextreme/` folder.

![gulp](gulp.png)
````bash
abp install-libs
````

You can see `devextreme` folder inside the `wwwroot/libs`:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ You can install the latest version (3.1.13 will be old)

#### 3- Add resource Mapping

We added SignalR to the `package.json` but it comes into your `node_modules` folder. We need to copy the related files to `wwwroot/libs` folder. To do this copy the content of the following file to your `abp.resourcemappings.js` file. It's in your root directory of Web folder. After you do this, go to your web directory and run `gulp` command. By doing this, it'll copy the related files into your `wwwroot/libs` folder.
We added SignalR to the `package.json` but it comes into your `node_modules` folder. We need to copy the related files to `wwwroot/libs` folder. To do this copy the content of the following file to your `abp.resourcemappings.js` file. It's in your root directory of Web folder. After you do this, go to your web directory and run `abp install-libs` command. By doing this, it'll copy the related files into your `wwwroot/libs` folder.

[abp.resourcemappings.js](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-abp-resourcemapping-js)

Expand Down
7 changes: 4 additions & 3 deletions docs/en/Modules/Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,11 @@ Open `package.json` and add `@abp/docs": "^2.9.0` as shown below:
}
```

Then open the command line terminal in the `Acme.MyProject.Web` project folder and run the following command:
Then open the command line terminal in the `Acme.MyProject.Web` project folder and run the following command:

1. `yarn`
2. `abp install-libs`
````bash
abp install-libs
````

### 4- Database Integration

Expand Down
5 changes: 3 additions & 2 deletions docs/en/Modules/Virtual-File-Explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ Or you can also manually install nuget package to `Acme.MyProject.Web` project:

Then open the command line terminal in the `Acme.MyProject.Web` project folder and run the following command:

1. `yarn`
2. `abp install-libs`
````bash
abp install-libs
````

That's all,Now run the application and Navigate to `/VirtualFileExplorer`. You will see virtual file explorer page:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/SignalR-Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ This will add the `@abp/signalr` to the dependencies in the `package.json` of yo
}
````

Run `abp install-libs` command in the root folder of your web project:
Run the following [ABP CLI](CLI.md) command in the root folder of your web project:

````bash
abp install-libs
Expand Down
18 changes: 5 additions & 13 deletions docs/en/UI/AspNetCore/Client-Side-Package-Management.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To solve the versioning problem, we created a **standard set of packages** those
The benefit of a **standard package** is:

* It depends on a **standard version** of a package. Depending on this package is **safe** because all modules depend on the same version.
* It contains the necessary mapping configuration to copy library resources (js, css, img... files) from the **node_modules** folder to **wwwroot/libs** folder. See the *Mapping The Library Resources* section for more.
* It contains the mappings copy library resources (js, css, img... files) from the **node_modules** folder to **wwwroot/libs** folder. See the *Mapping The Library Resources* section for more.

Depending on a standard package is easy. Just add it to your **package.json** file like you normally do. Example:

Expand Down Expand Up @@ -61,13 +61,7 @@ Using NPM packages and NPM/Yarn tool is the de facto standard for client side li

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.

[ABP CLI](../../CLI.md) offers the command below to **copy resources** from **node_modules** to **wwwroot/libs** folder. You have to run it in the root folder of your web project:

````bash
abp install-libs
````

Each **standard package** (see the *@ABP NPM Packages* section) defines the mapping for its own files. So, most of the time, you only configure dependencies.
ABP CLI's `abp install-libs` command **copies resources** from **node_modules** to **wwwroot/libs** folder. Each **standard package** (see the *@ABP NPM Packages* section) defines the mapping for its own files. So, most of the time, you only configure dependencies.

The **startup templates** are already configured to work all these out of the box. This section will explain the configuration options.

Expand Down Expand Up @@ -106,17 +100,15 @@ mappings: {
}
````

#### Using ABP CLI To Copy Resources
#### install-libs Command

Once you properly configure the `abp.resourcemapping.js` file, you can run the [ABP CLI](../../CLI.md) command from the command line:
Once you properly configure the `abp.resourcemapping.js` file, you can run the following ABP CLI command from the command line:

````bash
abp install-libs
````

When you run this command, all packages will copy their own resources into the **wwwroot/libs** folder. Running `yarn` & `abp install-libs` are only necessary if you make a change in your dependencies in the **package.json** file.

> When you run the `abp install-libs` command, dependencies of the application are resolved using the package.json file. [ABP CLI](../../CLI.md) automatically discovers and maps all resources from all dependencies (recursively).
When you run this command, all packages will copy their own resources into the **wwwroot/libs** folder. Running `abp install-libs` is only necessary if you make a change in your dependencies in the **package.json** file.

#### See Also

Expand Down
5 changes: 3 additions & 2 deletions docs/zh-Hans/Modules/Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,9 @@ ABP框架的[文档](docs.abp.io)也是使用的此模块.

然后在 `Acme.MyProject.Web` 项目目录打开命令行终端运行以下命令:

1. `yarn`
2. `gulp`
````bash
abp install-libs
````

### 4- 数据库集成

Expand Down
5 changes: 3 additions & 2 deletions docs/zh-Hans/Modules/Virtual-File-Explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@

然后在 `Acme.MyProject.Web` 项目目录打开命令行终端运行以下命令:

1. `yarn`
2. `gulp`
````bash
abp install-libs
````

这就是全部,运行应用程序导航到 `/VirtualFileExplorer`. 你会看到虚拟文件浏览器页面:

Expand Down
4 changes: 2 additions & 2 deletions docs/zh-Hans/SignalR-Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ yarn add @abp/signalr
}
````

在你的Web项目的根文件夹中运行 `gulp`:
在你的Web项目的根文件夹中运行 `abp install-libs`:

````bash
gulp
abp install-libs
````

它会将SignalR JavaScript文件拷贝到你的项目:
Expand Down
16 changes: 7 additions & 9 deletions docs/zh-Hans/UI/AspNetCore/Client-Side-Package-Management.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ABP是一个模块化平台. 每个开发人员都可以创建模块, 模块应
**标准包**的好处是:

* 它取决于包装的**标准版本**. 取决于此包是**安全**,因为所有模块都依赖于相同的版本.
* 它包含将库资源(js,css,img...文件)从**node_modules**文件夹复制到**wwwroot/libs**文件夹的gulp任务. 有关更多信息, 请参阅 *映射库资源* 部分.
* 它包含将库资源(js,css,img...文件)从**node_modules**文件夹复制到**wwwroot/libs**文件夹. 有关更多信息, 请参阅 *映射库资源* 部分.

依赖标准包装很容易. 只需像往常一样将它添加到**package.json**文件中. 例如:

Expand Down Expand Up @@ -61,7 +61,7 @@ yarn

下一个挑战是将所需的资源(js,css,img ...文件)从`node_modules`复制到**wwwroot**文件夹内的文件夹中,以使其可供客户端/浏览器访问.

ABP将基于[Gulp](https://gulpjs.com/)的任务定义为**将资源**从**node_modules**复制到**wwwroot/libs**文件夹. 每个**标准包**(参见*@ABP NPM Packages*部分)定义了自己文件的映射. 因此, 大多数情况你只配置依赖项.
ABP的 `install-libs` 命令**将资源**从**node_modules**复制到**wwwroot/libs**文件夹. 每个**标准包**(参见*@ABP NPM Packages*部分)定义了自己文件的映射. 因此, 大多数情况你只配置依赖项.

**启动模板**已经配置为开箱即用的所有这些. 本节将介绍配置选项.

Expand Down Expand Up @@ -97,17 +97,15 @@ mappings: {
}
````

#### 使用 Gulp
#### install-libs 命令

正确配置`abp.resourcemapping.js`文件后, 可以从命令行运行gulp命令:
正确配置`abp.resourcemapping.js`文件后, 可以从命令行运行ABP CLI命令:

````bash
abp install-libs
````
gulp
````

当你运行`gulp`时,所有包都会将自己的资源复制到**wwwroot/libs**文件夹中. 只有在**package.json**文件中对依赖项进行更改时, 才需要运行`yarn&gulp`.

> 运行Gulp命令时, 使用package.json文件解析应用程序的依赖关系. Gulp任务自动发现并映射来自所有依赖项的所有资源(递归).
当你运行这个命令时,所有包都会将自己的资源复制到**wwwroot/libs**文件夹中. 只有在**package.json**文件中对依赖项进行更改时, 才需要运行`abp install-libs`.

#### 参见

Expand Down