Merge pull request #137 from nmaas-platform/130-update-readme-file-content

Updated README.md content

README.md

+<div align="center">
+  <a href="https://docs.nmaas.eu/">
+    <img src="docs/nmaas-logo-blue.png" alt="Logo" width="206" height="48">
+  </a>
+
+  <h3 align="center">NMaaS Platform (Front-end)</h3>
+
+  <h4 align="center">Open-source multi-tenant platform for effortless, orchestrated deployment of software tools and applications on top of Kubernetes</h4>
+
+  <p align="center">
+    <br />
+    <a href="https://docs.nmaas.eu/">Explore documentation</a>
+    ·
+    <a href="https://github.com/nmaas-platform/nmaas-portal/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/nmaas-platform/nmaas-portal/issues">Request Feature</a>
+  </p>
+</div>
+
+## NMaaS Portal Component
+
+[NMaaS Portal](https://github.com/nmaas-platform/nmaas-portal) represents the front-end application of NMaaS that consumes the REST API offered by NMaaS Platform. NMaaS Portal is a Angular based application that is run in user's browser.
+
+### NMaaS Portal Development
+
+Explore the NMaaS Portal [development and deployment](docs/DEVELOPMENT.md) documentation.
+
+## Get in Touch
+
+Interested users can use the following mailing lists to subscribe to news about NMaaS, get in touch with the NMaaS development team, or other NMaaS users:
+
+- [nmaas-announce@lists.geant.org](mailto:nmaas-announce@lists.geant.org) - public mailing list for announcements shared by the NMaaS team with the community ([subscribe here](https://lists.geant.org/sympa/info/nmaas-announce))
+- [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org) - private mailing list for contacting the NMaaS core team members
+- [nmaas-users@lists.geant.org](mailto:nmaas-users@lists.geant.org) - public mailing lists for discussions related to NMaaS usage and development ([subscribe here](https://lists.geant.org/sympa/info/nmaas-users))

readme.md → docs/DEVELOPMENT.md

 # NMaaS Portal (GUI)
 
-### Web-based GUI for browsing, subscription and deployment of applications offered by the NMaaS Platform
-
 ### Technologies
 ---
 
@@ -15,11 +13,11 @@ See `package.json` for detailed package list.
 
 ### Prerequisites
 ---
- + Install node and npm (min version is node v14, but suggested is v16)
- + Install git
- + Clone project and run `npm install` in project *root* directory
- + (running on server) Build project using `ng build` and deploy using http server of your choice
- + (running tests) Chrome is required for running tests, however `karma-chrome-launcher` should download Chrome automatically if it is not detected. Run test using `npm test` or `npm test-headless`. See `package.json` for detailed test commands.
++ Install node and npm (min version is node v14, but suggested is v16)
++ Install git
++ Clone project and run `npm install` in project *root* directory
++ (running on server) Build project using `ng build` and deploy using http server of your choice
++ (running tests) Chrome is required for running tests, however `karma-chrome-launcher` should download Chrome automatically if it is not detected. Run test using `npm test` or `npm test-headless`. See `package.json` for detailed test commands.
 
 ### Running NMaaS Portal locally
 ---
@@ -30,17 +28,17 @@ Note: First run requires entering `npm install` command in order to install all
 
 ### Running NMaaS Portal on dedicated machine
 ---
-  In order to run NMaaS Portal on dedicated machine perform the following steps:
-  + Build the NMaaS Portal by running `gradlew clean build` in the reactor directory.
-    - In order to build for production environment use additional option `--configuration production`
-  + The output archive `nmaas-portal-x.x.x.zip` file is created in `nmaas-portal/build/distributions` directory.
-  + Run the http server in `nmaas-portal/build/app`
-    - `nohup angular-http-server -p 9009 -s --cors > nmaas-portal.log 2> Error.err < /dev/null &`
+In order to run NMaaS Portal on dedicated machine perform the following steps:
++ Build the NMaaS Portal by running `gradlew clean build` in the reactor directory.
+  - In order to build for production environment use additional option `--configuration production`
++ The output archive `nmaas-portal-x.x.x.zip` file is created in `nmaas-portal/build/distributions` directory.
++ Run the http server in `nmaas-portal/build/app`
+  - `nohup angular-http-server -p 9009 -s --cors > nmaas-portal.log 2> Error.err < /dev/null &`
 
 ### Lunching tests
 ---
 Run `./gradlew run testCoverage` in this directory.
-Results of executed tests are displayed on screen. 
+Results of executed tests are displayed on screen.
 More information about code quality (including code coverage, test status) are available in `nmaas-portal/coverage/index.html`
 
 ### Default settings
@@ -52,7 +50,7 @@ NMaaS Portal and Platform URLs:
 Admin user:
 + username: `admin`
 + password: `admin`
-    
+
 ### Building and uploading NMaaS Portal Docker image
 ---
 In order to build the NMaaS Portal Docker image first alter the `build_and_publish.sh` script with custom REPOSITORY, PACKAGE and TAG values and execute `build_and_publish.sh` to automatically build and publish `nmaas-portal` image to selected Docker repository.