README.md

   1 # O-RAN-SC RIC Dashboard Web Application
   2
   3 The O-RAN SC RIC Dashboard provides administrative and operator functions
   4 for a disaggregated radio access network (RAN) controller.
   5 The web app is built as a single-page app using an Angular 8 front end
   6 and a Spring-Boot 2 back end.
   7
   8 ## Deployment configuration
   9
  10 The application expects the following configuration files,
  11 usually mounted as files from Kubernetes configuration maps:
  12
  13     application.properties (in launch directory)
  14     key.properties (on classpath)
  15     portal.properties (on classpath)
  16
  17 Sample files are in directory src/main/resources and src/test/resources.
  18
  19 ## Development guide
  20
  21 This section gives a quickstart guide for developers.
  22
  23 ### Prerequisites
  24
  25 1. Java development kit (JDK), version 11 or later
  26 2. Maven dependency-management tool, version 3.4 or later
  27
  28 ### Build and launch the web app
  29
  30 Instructions for launching a backend Sprint-Boot server
  31 are available in the webapp-backend README file.
  32 After launching, open a browser on http://localhost:8080
  33
  34 Instructions for launching a frontend Angular server (only for development)
  35 are available in the webapp-frontend README file.
  36 After launching, open a browser on http://localhost:4200
  37
  38 ## License
  39
  40 Copyright (C) 2019 AT&T Intellectual Property & Nokia. All rights reserved.
  41 Licensed under the Apache License, Version 2.0 (the "License");
  42 you may not use this file except in compliance with the License.
  43 You may obtain a copy of the License at
  44
  45      http://www.apache.org/licenses/LICENSE-2.0
  46
  47 Unless required by applicable law or agreed to in writing, software
  48 distributed under the License is distributed on an "AS IS" BASIS,
  49 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  50 See the License for the specific language governing permissions and
  51 limitations under the License.