README.md

   1 <!--
   2 Copyright 2020 TATA ELXSI
   3
   4 Licensed under the Apache License, Version 2.0 (the "License");
   5 you may not use this file except in compliance with the License.
   6 You may obtain a copy of the License at
   7
   8     http://www.apache.org/licenses/LICENSE-2.0
   9
  10 Unless required by applicable law or agreed to in writing, software
  11 distributed under the License is distributed on an "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 See the License for the specific language governing permissions and
  14 limitations under the License.
  15
  16 Author: KUMARAN M (kumaran.m@tataelxsi.co.in), RAJESH S (rajesh.s@tataelxsi.co.in), BARATH KUMAR R (barath.r@tataelxsi.co.in)
  17 -->
  18
  19 ## Angular Based OSM NG UI
  20 This project focuses on the implementation of a web GUI to interact with the Northbound API of OSM.
  21
  22 The project is based on ([Angular](https://angular.io/)), a One framework for Mobile & desktop, app-design framework and development platform for creating efficient and sophisticated single-page web apps.
  23
  24 ## Table of Contents
  25
  26 * [Community](#community)
  27 * [Getting Started](#getting-started)
  28 * [Prerequisites](#prerequisites)
  29 * [Installation](#installation)
  30 * [Running the application](#running-the-application)
  31 * [Check the lint](#check-the-lint)
  32 * [Supported Browsers](#supported-browsers)
  33 * [Deployment](#deployment)
  34 * [Built With](#built-with)
  35 * [Contributing](#contributing)
  36 * [Versioning](#versioning)
  37 * [License](#license)
  38
  39 ## Community
  40
  41 Contact [kumaran.m@tataelxsi.co.in](mailto:kumaran.m@tataelxsi.co.in), [rajesh.s@tataelxsi.co.in](mailto:rajesh.s@tataelxsi.co.in), [barath.r@tataelxsi.co.in](mailto:barath.r@tataelxsi.co.in) for architecture and design discussions, requests for help, features request and bug reports on NG UI.
  42
  43 ## Getting Started
  44
  45 Following instructions in the sections below will get you a copy of the project up and running on your local machine for development and testing purposes. See Deployment section for notes on how to deploy the project on a live system.
  46
  47 ### Prerequisites
  48
  49 Angular Setup, Install, & Build Guide
  50
  51 1. Install Node.js from [here](https://nodejs.org/en/download/)
  52 To check if nodejs is installed on your system, type below command. This will help you see the version of nodejs currently installed on your system.
  53 `node -version`
  54 After downloading Node.js, the node package manager (npm) should automatically be installed. Test it out by doing:
  55 `npm --version`
  56 2. Install Angluar CLI. [More details](https://cli.angular.io/) Angular can be installed Globally (or) Locally,
  57 Install Globally
  58 `npm install -g @angular/cli`
  59 Install Locally
  60 `npm install @angular/cli`
  61 After installation done you can check the version using below command. It will display version details of angular-cli
  62 `ng version`
  63
  64 We are done with the installation of Angular
  65
  66 ### Installation
  67
  68 Clone the NG UI from the repository
  69
  70 `git clone "https://osm.etsi.org/gerrit/osm/NG-UI"`
  71
  72 Install the packages
  73
  74 `cd NG-UI`
  75
  76 `npm install`
  77
  78 ### Running the application
  79
  80 The following instructions is for running NG UI locally for development purpose,
  81
  82 On the folder project
  83
  84 Open `proxy.conf.json`
  85
  86 Add the below code
  87 ```typescript
  88 {
  89     "/osm/*": {
  90         "target": "https://OSM-NBI-IP:9999",
  91         "secure": false,
  92         "logLevel": "info"
  93     }
  94 }
  95 ```
  96 To run the application give the below command
  97
  98 `npm run proxy`
  99 - To Run the NG-UI page Navigate to <http://localhost:4200/>
 100
 101 ## Check the lint
 102
 103 To check the typescript lint run the below command
 104
 105 `npm run lint`
 106
 107 ## Supported Browsers
 108
 109 - Edge (42.17134.1098.0) and IE 11 (Windows)
 110 - Firefox (75.0)(Ubunutu)
 111 - Firefox (75.0)(Windows)
 112 - Chrome (81.0.4044.92) (Ubunutu)
 113 - Chrome (81.0.4044.122) (Windows)
 114
 115 ## Deployment
 116
 117 To deploy the NG UI use the [Dockerfile](Dockerfile)
 118
 119 ## Built With
 120
 121 * [Angular Frame work](https://angular.io/) - The languages used are Javascript, Typescript, HTML, and SCSS
 122
 123 ## Contributing
 124
 125 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 126
 127 ## Versioning
 128
 129 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://osm.etsi.org/gitweb/?p=osm/NG-UI.git;a=tags).
 130
 131 ## License
 132
 133 This project is licensed under the Apache2 License - see the [LICENSE.md](LICENSE) file for details