Skip to content

Commit 9a2a13b

Browse files
authored
Update BuildFromSource.md
1 parent 1e8fe7e commit 9a2a13b

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

docs/BuildFromSource.md

+34-4
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ These principles guide how we create and manage .slnf files:
8787
./restore.ps1
8888
```
8989
90-
2. After the restore script has finished executing, activate the locally installed .NET by running the following command.
90+
4. After the restore script has finished executing, activate the locally installed .NET by running the following command.
9191
9292
```bash
9393
source activate.sh
@@ -97,14 +97,14 @@ source activate.sh
9797
. ./activate.ps1
9898
```
9999
100-
3. After activating the locally installed .NET, you can open your project of choice by running the `code` command in the directory of choice. For example, if you want to modify code in the `src/Http` project, you can use the following:
100+
5. After activating the locally installed .NET, you can open your project of choice by running the `code` command in the directory of choice. For example, if you want to modify code in the `src/Http` project, you can use the following:
101101
102102
```bash
103103
cd src/Http
104104
code .
105105
```
106106
107-
4. Once you've opened the project in VS Code, you can build and test changes by running the `./build.sh` command in the terminal.
107+
6. Once you've opened the project in VS Code, you can build and test changes by running the `./build.sh` command in the terminal.
108108
109109
> :bulb: The `build.sh` or `build.ps1` script will be local to the directory of the project that you have opened. For example, the script located in the `src/Http` directory.
110110
@@ -113,7 +113,7 @@ code .
113113
./build.sh -test
114114
```
115115
116-
5. Alternatively, you can use the `dotnet test` and `dotnet build` commands directly once you've activated the locally installed .NET SDK.
116+
7. Alternatively, you can use the `dotnet test` and `dotnet build` commands directly once you've activated the locally installed .NET SDK.
117117
118118
```bash
119119
source activate.sh
@@ -138,6 +138,36 @@ If you have [Codespaces enabled on your GitHub user account](https://github.com/
138138
139139
See [BuildErrors](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildErrors.md) for a description of common issues you might run into while building the repo.
140140
141+
## A Guide to Build src\Components\Web.JS
142+
143+
Prior to building `src\Components\Web.JS\`
144+
145+
1. You'll need to install [Node](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/) on your machine.
146+
2. You'll need to run the `restore` script locally to install the required dotnet dependencies and setup the repo. The `restore` script is located in the root of the repo.
147+
148+
```bash
149+
./restore.sh
150+
```
151+
152+
```powershell
153+
./restore.ps1
154+
```
155+
156+
3. After the restore script has finished executing, activate the locally installed .NET by running the following command.
157+
158+
```bash
159+
source activate.sh
160+
```
161+
162+
```powershell
163+
. ./activate.ps1
164+
```
165+
166+
Now you can build `src\Components\Web.JS\` by running the following command in the directory.
167+
```powershell
168+
dotnet build
169+
```
170+
141171
## A Guide to the Build Script
142172
143173
This ASP.NET Core repo contains a top-level build script located at `eng/build.cmd` and `eng/build.sh` and local build scripts within each directory. The scripts can be used to restore, build, and test the repo with support for a variety of flags. This section documents the common flags and some recommended invocation patterns.

0 commit comments

Comments
 (0)