-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
140 lines (108 loc) · 6.74 KB
/
index.html
File metadata and controls
140 lines (108 loc) · 6.74 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>ui documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="./images/favicon.ico">
<link rel="stylesheet" href="./styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="./" class="navbar-brand">ui documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content getting-started">
<div class="content-data">
<h1 id="ui">Ui</h1>
<p>This project was generated with <a href="https://github.com/angular/angular-cli">Angular CLI</a> version 7.3.0.</p>
<h2 id="pre-requisites">Pre-requisites</h2>
<p>Run <code>npm config set @bmc-ux:registry http://cdn.bmc.com:4873</code> to set the BMC adapt repository(One time setup).
Run <code>npm ci</code> to download dependencies specified in package-lock.json.
Need to run this whenever there is a change in package.json and package-lock.json.</p>
<h2 id="development-server">Development server</h2>
<p>From current directory,
Run <code>ng build common</code> to build the common library first.
Need to build common library whenever there is a change in common.
Run <code>ng serve project-name</code> for a dev server. Navigate to <code>http://localhost:4200/</code>. The app will automatically reload if you change any of the source files.
For eg., running bcan project, run <code>ng serve bcan</code>.</p>
<h2 id="code-scaffolding">Code scaffolding</h2>
<p>Change directory to 'projects/project-name/src/app'.
Run <code>ng generate component component-name --skip-tests --style=scss</code> to generate a new component without tests file and with scss styling.
You can also use <code>ng generate directive|pipe|service|class|guard|interface|enum|module</code>.
For eg., creating component test in admin directory of bcan, run <code>cd projects/bcan/src/app; ng generate component admin/test --skip-test --style=scss</code>.
Run <code>ng generate component component-name --dry-run --skip-tests --skip-import --style=scss</code> to dry run your command and check which files will be created on actual generation without actually creating the files.</p>
<h2 id="build">Build</h2>
<p>The build artifacts will be stored in the <code>dist/</code> directory. Use the <code>--prod</code> flag for a production build.
Run <code>ng build common</code> to build the common library.
Run <code>ng build project-name --prod</code>, for production build of project.
For eg., for production build of bcan, <code>ng build bcan --prod</code>.</p>
<h2 id="npm-scripts">NPM scripts</h2>
<p>These are shorthands for running the commands specified above.
For building common, run <code>npm run release-common</code>.
For building any project, <code>npm run build project-name</code>.
For starting dev server for a project, <code>npm run start project-name</code>. (Common must be built first).
For production build of project along with common, <code>npm run release-project-name</code>. eg., <code>npm run release-bcan</code>.
For running lint on overall UI folder, <code>npm run lint</code>.
For running lint on specific project, <code>npm run lint project-name</code>. eg., <code>npm run lint bcan</code>.</p>
<h2 id="development-environment">Development environment</h2>
<p>Rest API's are deployed on local server first, i.e Run BNA in cygwin.
Build and serve the project in cmd.
To access the UI, goto <code>http://localhost:4200/</code> from a security disabled web browser to allow cross oirigin access for rest api's. (ISSUE ONLY FOR DEV).
Get the browser certificate on the '<a href="http://localhost:8443'">http://localhost:8443'</a> restapi page first to allow access of the rest api's in the same security disabled web browser.
You are now set to use the new UI with the Rest api's.</p>
<h2 id="further-help">Further help</h2>
<p>To get more help on the Angular CLI use <code>ng help</code> or go check out the <a href="https://github.com/angular/angular-cli/blob/master/README.md">Angular CLI README</a>.</p>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 0;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
var COMPODOC_CURRENT_PAGE_URL = 'index.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="./js/libs/custom-elements.min.js"></script>
<script src="./js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="./js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="./js/menu-wc.js" defer></script>
<script src="./js/libs/bootstrap-native.js"></script>
<script src="./js/libs/es6-shim.min.js"></script>
<script src="./js/libs/EventDispatcher.js"></script>
<script src="./js/libs/promise.min.js"></script>
<script src="./js/libs/zepto.min.js"></script>
<script src="./js/compodoc.js"></script>
<script src="./js/tabs.js"></script>
<script src="./js/menu.js"></script>
<script src="./js/libs/clipboard.min.js"></script>
<script src="./js/libs/prism.js"></script>
<script src="./js/sourceCode.js"></script>
<script src="./js/search/search.js"></script>
<script src="./js/search/lunr.min.js"></script>
<script src="./js/search/search-lunr.js"></script>
<script src="./js/search/search_index.js"></script>
<script src="./js/lazy-load-graphs.js"></script>
</body>
</html>