X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=3cec2d6039c1d8cc0cfc624d7b3b49ad0d2426fb;hb=81c5a43871449332f9a9560c7cf25d07cf714d8e;hp=0333213d3b8977b54e0d53a0c47ad45348ac7424;hpb=be7a01eda7e4fb9f97a18009d727e6a0692e9399;p=portal%2Fric-dashboard.git diff --git a/README.md b/README.md index 0333213d..3cec2d60 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,46 @@ This webapp is built with Angular 7 and Spring-Boot 2. -## Getting started +## Deployment configuration -To install prerequisites on Mac OSX, first install nvm then continue with node: +The application expects an application.properties file to be provided, +probably mounted as a file from a Kubernetes configuration map, with +the following content: - curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash + # A1 Mediator + a1med.url = http://A1-URL + # ANR xApp + anrxapp.url = http://ANR-URL + # E2 Manager + e2mgr.url = http://E2-URL + # Xapp Manager + xappmgr.url = http://MGR-URL -Then: +## Development guide - nvm install stable - nvm install node +This section gives a quickstart guide for developers. -To run the web app: +### Check prerequisites - cd ric-dashboard/ang7-sb2 - mvn clean install +1. Java development kit (JDK), version 1.8 or later +2. Maven dependency-management tool, version 3.4 or later - cd ric-dashboard/ang7-sb2/backend/ +### Build and launch the web app + + mvn -Ddocker.skip=true clean install + cd webapp-backend mvn spring-boot:run -To debug the frontend and backend for Angular developers: +Then open a browser on http://localhost:8080 + +In addition to the above, you can run the Angular server +for debugging the frontend and backend separately: - cd ric-dashboard/ang7-sb2/frontend/src/main/web/src/app + cd webapp-frontend ./ng serve --proxy-config proxy.conf.json +Then open a browser on http://localhost:4200 + ## License Copyright (C) 2019 AT&T Intellectual Property & Nokia. All rights reserved.