README.md

   1 # O-RAN-SC RIC Dashboard Web Application
   2
   3 This webapp is built with Angular 7 and Spring-Boot 2.
   4
   5 ## Deployment configuration
   6
   7 The application expects an application.properties file to be provided,
   8 probably mounted as a file from a Kubernetes configuration map, with
   9 the following content:
  10
  11     # A1 Mediator
  12     a1med.url = http://A1-URL
  13     # ANR xApp
  14     anrxapp.url = http://ANR-URL
  15     # E2 Manager
  16     e2mgr.url = http://E2-URL
  17     # Xapp Manager
  18     xappmgr.url = http://MGR-URL
  19
  20 ## Development guide
  21
  22 This section gives a quickstart guide for developers.
  23
  24 ### Check prerequisites
  25
  26 1. Java development kit (JDK), version 1.8 or later
  27 2. Maven dependency-management tool, version 3.4 or later
  28
  29 ### Build and launch the web app
  30
  31     mvn -Ddocker.skip=true clean install
  32     cd webapp-backend
  33     mvn spring-boot:run
  34
  35 Then open a browser on http://localhost:8080
  36
  37 In addition to the above, you can run the Angular server
  38 for debugging the frontend and backend separately:
  39
  40     cd webapp-frontend
  41     ./ng serve --proxy-config proxy.conf.json
  42
  43 Then open a browser on http://localhost:4200
  44
  45 ## License
  46
  47 Copyright (C) 2019 AT&T Intellectual Property & Nokia. All rights reserved.
  48 Licensed under the Apache License, Version 2.0 (the "License");
  49 you may not use this file except in compliance with the License.
  50 You may obtain a copy of the License at
  51
  52      http://www.apache.org/licenses/LICENSE-2.0
  53
  54 Unless required by applicable law or agreed to in writing, software
  55 distributed under the License is distributed on an "AS IS" BASIS,
  56 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  57 See the License for the specific language governing permissions and
  58 limitations under the License.