Fix mistakes in docs.
[portal/nonrtric-controlpanel.git] / webapp-frontend / README.md
1 # Non-RT RIC Control Panel Web Application Frontend
2
3 ## Development server
4
5 Run `./ng serve --proxy-config proxy.conf.json` or `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
6
7 You may also need to Start the Control Panel Gateway, Policy Management Service & EI Coordinator if you want to view the data in UI.
8
9 ## Development server with Mock Data
10
11 Run `npm run start:mock` for a dev server with mock data. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. This enables the developer to test the UI without the need of backend.
12
13 ## Build
14
15 Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
16
17 ## Running unit tests
18
19 Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20
21 ## Running end-to-end tests
22
23 Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
24
25 ## License
26
27 Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
28 Modifications Copyright (C) 2019 Nordix Foundation
29 Modifications Copyright (C) 2020 Nordix Foundation
30 Licensed under the Apache License, Version 2.0 (the "License");
31 you may not use this file except in compliance with the License.
32 You may obtain a copy of the License at
33
34      http://www.apache.org/licenses/LICENSE-2.0
35
36 Unless required by applicable law or agreed to in writing, software
37 distributed under the License is distributed on an "AS IS" BASIS,
38 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
39 See the License for the specific language governing permissions and
40 limitations under the License.
41