Improve documentation
[portal/nonrtric-controlpanel.git] / README.md
1 # O-RAN-SC Non-RT RIC Control Panel Web Application
2
3 The O-RAN Non-RT RIC Control Panel provides administrative and operator functions for a Near-RT RIC through the A1 API.
4 This web app consists of an Angular (version 9) front end, see [frontend](webapp-frontend/README.md),
5 and a Java (version 11) Spring Cloud Gateway (version 2020.0.0), see [gateway](nonrtric-gateway/README.md).
6
7 Please see the documentation in the docs/ folder.
8
9 The backend server publishes live API documentation at the
10 URL `http://your-host-name-here:8080/swagger-ui.html`
11
12 ## License
13
14 Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
15 Modifications Copyright (C) 2019 Nordix Foundation
16 Licensed under the Apache License, Version 2.0 (the "License");
17 you may not use this file except in compliance with the License.
18 You may obtain a copy of the License at
19
20      http://www.apache.org/licenses/LICENSE-2.0
21
22 Unless required by applicable law or agreed to in writing, software
23 distributed under the License is distributed on an "AS IS" BASIS,
24 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25 See the License for the specific language governing permissions and
26 limitations under the License.