Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Commit

Permalink
Merge pull request #527 from abpio/EngincanV/docs-mention-commands
Browse files Browse the repository at this point in the history
Mention yarn / abp install-libs / abp bundle commands in related documentation
  • Loading branch information
hikalkan authored Oct 17, 2023
2 parents fbe918f + 734866a commit 049dbe9
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 2 deletions.
32 changes: 30 additions & 2 deletions en/getting-started-running-solution.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,40 @@ Right click to the `.DbMigrator` project and select **Set as StartUp Project**
{{ end }}

## Before Running the Application

### Installing the Client-Side Packages

[ABP CLI](https://docs.abp.io/en/abp/latest/CLI) runs the `abp install-libs` command behind the scenes to install the required NPM packages for your solution while creating the application. So, if you have created the application via ABP CLI or [ABP Suite](./abp-suite/index.md), you don't need to run this command manually.

However, sometimes this command might need to be manually run. For example, you need to run this command, if you have cloned the application, or the resources from *node_modules* folder didn't copy to *wwwroot/libs* folder, or if you have added a new client-side package dependency to your solution.

For such cases, run the `abp install-libs` command on the root directory of your solution to install all required NPM packages:

```bash
abp install-libs
```

> We suggest you install [Yarn](https://classic.yarnpkg.com/) to prevent possible package inconsistencies, if you haven't installed it yet.
{{if UI=="Blazor" || UI="BlazorServer"}}

### Bundling and Minification

`abp bundle` command offers bundling and minification support for client-side resources (JavaScript and CSS files) for Blazor projects. This command automatically run when you create a new solution with the [ABP CLI](https://docs.abp.io/en/abp/latest/CLI).

However, sometimes you might need to run this command manually. To update script & style references without worrying about dependencies, ordering, etc. in a project, you can run this command in the directory of your blazor application:

```bash
abp bundle
```

> For more details about managing style and script references in Blazor or MAUI Blazor apps, see [Managing Global Scripts & Styles](https://docs.abp.io/en/abp/latest/UI/Blazor/Global-Scripts-Styles).
{{end}}

## Run the application

{{ if UI == "MVC" || UI == "BlazorServer" }}

> Warning: When you create an ABP solution, the client-side packages are being restored by ABP CLI and Suite. But if you fetch the source-code that's commited by another team member, your `libs` folder will be empty. Before starting the application, run `abp install-libs` command in your Web directory to restore the client-side libraries. This will populate the `libs` folder.
{{ if Tiered == "Yes" }}

> Tiered solutions use Redis as the distributed cache. Ensure that it is installed and running in your local computer. If you are using a remote Redis Server, set the configuration in the `appsettings.json` files of the projects below.
Expand Down
33 changes: 33 additions & 0 deletions en/tutorials/book-store/part-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,43 @@ This tutorial has multiple versions based on your **UI** and **Database** prefer

> If you encounter the "filename too long" or "unzip" error on Windows, please see [this guide](https://docs.abp.io/en/abp/7.0/KB/Windows-Path-Too-Long-Fix).
> After downloading the source code, you might need to run some commands before running the application. See the _After Creating the Solution_ section below for more information.
## Creating the Solution

Before starting to the development, create a new solution named `Acme.BookStore` and run it by following the [getting started tutorial](../../getting-started.md).

## After Creating the Solution

### Installing the Client-Side Packages

[ABP CLI](https://docs.abp.io/en/abp/latest/CLI) runs the `abp install-libs` command behind the scenes to install the required NPM packages for your solution while creating the application. So, if you have created the application via ABP CLI or [ABP Suite](../../abp-suite/index.md), you don't need to run this command manually.

However, sometimes this command might need to be manually run. For example, you need to run this command, if you have cloned the application, or the resources from *node_modules* folder didn't copy to *wwwroot/libs* folder, or if you have added a new client-side package dependency to your solution.

For such cases, run the `abp install-libs` command on the root directory of your solution to install all required NPM packages:

```bash
abp install-libs
```

> We suggest you install [Yarn](https://classic.yarnpkg.com/) to prevent possible package inconsistencies, if you haven't installed it yet.
{{if UI=="Blazor" || UI="BlazorServer"}}

### Bundling and Minification

`abp bundle` command offers bundling and minification support for client-side resources (JavaScript and CSS files) for Blazor projects. This command automatically run when you create a new solution with the [ABP CLI](https://docs.abp.io/en/abp/latest/CLI).

However, sometimes you might need to run this command manually. To update script & style references without worrying about dependencies, ordering, etc. in a project, you can run this command in the directory of your blazor application:

```bash
abp bundle
```

> For more details about managing style and script references in Blazor or MAUI Blazor apps, see [Managing Global Scripts & Styles](https://docs.abp.io/en/abp/latest/UI/Blazor/Global-Scripts-Styles).
{{end}}


## Create the Book Entity

**Domain layer** in the startup template is separated into two projects:
Expand Down

0 comments on commit 049dbe9

Please sign in to comment.