X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=2e419418412c85241347d5a95c76252dc2e77412;hb=HEAD;hp=5553352c7a68574485383a079b3ffe9cafec3db7;hpb=e2cbc4d0304646febf7e2cbe0dccdf9840189222;p=portal%2Fric-dashboard.git diff --git a/README.md b/README.md index 5553352c..2e419418 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,18 @@ -# ORAN-OSC RIC Dashboard Web Application +# 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. -## Getting started +Please see the documentation in the docs/ folder. -To install prerequisites on Mac OSX, first install nvm then continue with node: - - curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash - -Then: - - nvm install stable - nvm install node - -To run the web app: - - cd ric-dashboard/ang7-sb2 - mvn clean install - - cd ric-dashboard/ang7-sb2/backend/ - mvn spring-boot:run - -To debug the frontend and backend for Angular developers: - - cd ric-dashboard/ang7-sb2/frontend/src/main/web/src/app - ./ng serve --proxy-config proxy.conf.json +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