diff options
author | Surayya Huseyn Zada <114938397+surayya-MS@users.noreply.github.com> | 2022-10-26 15:22:20 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-26 15:22:20 +0300 |
commit | c7111fe868c8d6631b3f4f751c07b5a90900d2e7 (patch) | |
tree | bf40027d0afc422b629f5ded2626395f59540dd4 /src | |
parent | 9a2a13b6bd660fc5dd594cb92baaa3daed9b9a18 (diff) |
Update README.md
Diffstat (limited to 'src')
-rw-r--r-- | src/Components/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/Components/README.md b/src/Components/README.md index c787c4c90b..b4ccf0f39f 100644 --- a/src/Components/README.md +++ b/src/Components/README.md @@ -35,6 +35,36 @@ To build this specific project from source, follow the instructions [on building **Note:** You also need to run the preceding `build` command in the command line before building in VS to ensure that the Web.JS dependency is built. +### A Guide to Web.JS + +Prior to building `src\Components\Web.JS\` + +1. You'll need to install [Node](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/) on your machine. +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. + +```bash +./restore.sh +``` + +```powershell +./restore.ps1 +``` + +3. After the restore script has finished executing, activate the locally installed .NET by running the following command. + +```bash +source activate.sh +``` + +```powershell +. ./activate.ps1 +``` + +Now you can build `src\Components\Web.JS\` by running the following command in the directory. +```powershell +dotnet build +``` + ### Test This project contains a collection of unit tests implemented with XUnit and E2E tests implemented using Selenium. In order to run the E2E tests, you will need to have [Node v16](https://nodejs.org/en/) installed on your machine. |