From b1c436ae55fe1f3add627719ec9a580e74d8edf3 Mon Sep 17 00:00:00 2001
From: Martin Stockhammer <martin_s@apache.org>
Date: Thu, 5 Nov 2020 11:14:34 +0100
Subject: [PATCH] Adding setup documentation for angular

---
 .../src/main/archiva-web/README.md            | 44 +++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/archiva-modules/archiva-web/archiva-webapp/src/main/archiva-web/README.md b/archiva-modules/archiva-web/archiva-webapp/src/main/archiva-web/README.md
index 2953beb62..1714eee85 100644
--- a/archiva-modules/archiva-web/archiva-webapp/src/main/archiva-web/README.md
+++ b/archiva-modules/archiva-web/archiva-webapp/src/main/archiva-web/README.md
@@ -3,6 +3,50 @@
 This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.1.
 
 ## Usage instructions
+
+### Setup environment
+
+You need npm and nodejs, the nodejs version must be at least 10.x or 12.x 
+
+Install ng client:
+```shell script
+:> nodejs --version
+v12.19.0
+:> npm --version
+6.14.8
+
+npm install -g @angular/cli
+
+cd src/main/archiva-web
+npm install
+
+ng --version
+Angular CLI: 10.2.0
+Node: 12.19.0
+OS: linux x64
+
+Angular: 10.2.0
+... animations, cli, common, compiler, compiler-cli, core, forms
+... platform-browser, platform-browser-dynamic, router
+Ivy Workspace: Yes
+
+Package                         Version
+---------------------------------------------------------
+@angular-devkit/architect       0.1002.0
+@angular-devkit/build-angular   0.1002.0
+@angular-devkit/core            10.2.0
+@angular-devkit/schematics      10.2.0
+@schematics/angular             10.2.0
+@schematics/update              0.1002.0
+rxjs                            6.6.3
+typescript                      3.9.6
+
+```
+After that, there should be a node_modules directory in the working directory and the ng client
+should be runnable.
+
+
+
 ### Development server
 
 Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.