X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=2e419418412c85241347d5a95c76252dc2e77412;hb=HEAD;hp=3cec2d6039c1d8cc0cfc624d7b3b49ad0d2426fb;hpb=a91a1032725b91b493c060937b3f27ac9e62807e;p=portal%2Fric-dashboard.git diff --git a/README.md b/README.md index 3cec2d60..2e419418 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,18 @@ # O-RAN-SC RIC Dashboard Web Application -This webapp is built with Angular 7 and Spring-Boot 2. +The O-RAN SC RIC Dashboard provides administrative and operator +functions for a radio access network (RAN) controller. +This web app consists of an Angular (version 8) front end +and a Java (version 11) Spring-Boot (version 2.2) back end. -## Deployment configuration +Please see the documentation in the docs/ folder. -The application expects an application.properties file to be provided, -probably mounted as a file from a Kubernetes configuration map, with -the following content: - - # 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 - -## Development guide - -This section gives a quickstart guide for developers. - -### Check prerequisites - -1. Java development kit (JDK), version 1.8 or later -2. Maven dependency-management tool, version 3.4 or later - -### Build and launch the web app - - mvn -Ddocker.skip=true clean install - cd webapp-backend - mvn spring-boot:run - -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 webapp-frontend - ./ng serve --proxy-config proxy.conf.json - -Then open a browser on http://localhost:4200 +The backend server publishes live API documentation at the +URL `http://your-host-name-here:8080/swagger-ui.html` ## License -Copyright (C) 2019 AT&T Intellectual Property & Nokia. All rights reserved. +Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at