docs(ui): update frontend README
refactor(ui): comment out notifications dash box (will use sidebar entry instead)
MODIFY
manager/ui/war/README.md
manager/ui/war/README.md
@@ -8,15 +8,12 @@ To install dependencies on the front-end, run the following:
`yarn install`
-This will install NPM dependencies and TS definitions (through an NPM `postinstall` script). No need to install any
-dependencies globally!
-
## Configuration
* Make a copy of *apiman/config.js-SAMPLE* and name it *apiman/config.js*
* Configure *config.js* to work with your API Manager
-_Note_: when running the API Manager UI in gulp, we will use simple BASIC authentication
+_Note_: when running the API Manager UI in development mode, we will use simple BASIC authentication
with the credentials configured in the *config.js* file you created above. The *config.js*
file is local to your machine and not checked into version control.
@@ -24,9 +21,9 @@ file is local to your machine and not checked into version control.
To build and run the app:
-`npx gulp`
+`yarn serve`
-The above script will also monitor for changes, and will rebuild the app accordingly. To see exactly which files are monitored, check the `watch` task in the Gulpfile, located in `/apiman/manager/ui/war/gulpfile.js`.
+Edits should automatically be detected and refresh (although certain HTML edits may require a manual refresh).
## Contributing

MODIFY
manager/ui/war/index.html
manager/ui/war/index.html
<!DOCTYPE html>
<html lang="en">
-
<head>
<meta charset="utf-8">
<title>Apiman</title>
<base href='/'>
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
</head>
+
<body>
<div ng-view ng-strict-di="true"></div>
</body>

MODIFY
manager/ui/war/package.json
manager/ui/war/package.json
{
"name": "apiman-manager-ui",
- "version": "1.2.0",
- "description": "apiman's UI component, written principally in AngularJS",
+ "version": "1.3.0",
+ "description": "Apiman's UI component, written principally in AngularJS",
"main": "dist/apiman-manager.js",
"repository": {
"type": "git",

MODIFY
manager/ui/war/plugins/api-manager/html/dash.html
manager/ui/war/plugins/api-manager/html/dash.html
</div>
</div>
- <div class="dash-group">
- <div class="title">
- <i class="fa fa-code-fork"></i>
- <span apiman-i18n-key="notifications">Notifications</span>
- </div>
- <div class="description" apiman-i18n-key="dash.devportal-description">
- Manage your notifications, including approving requests by developers to sign up to APIs.
- </div>
- <div class="actions">
- <ul>
+<!-- <div class="dash-group">-->
+<!-- <div class="title">-->
+<!-- <i class="fa fa-code-fork"></i>-->
+<!-- <span apiman-i18n-key="notifications">Notifications</span>-->
+<!-- </div>-->
+<!-- <div class="description" apiman-i18n-key="dash.devportal-description">-->
+<!-- Manage your notifications, including approving requests by developers to sign up to APIs.-->
+<!-- </div>-->
+<!-- <div class="actions">-->
+<!-- <ul>-->
<!-- <li>Developer account approvals</li>-->
- <li><a href="">API Signup Approval Requests</a></li>
-<!-- <li>Manage notifications -- probably should be in notifications area</li>-->
- </ul>
- </div>
- </div>
+<!-- <li><a href="">API Signup Approval Requests</a></li>-->
+<!-- <li>Manage notifications</li>-->
+<!-- </ul>-->
+<!-- </div>-->
+<!-- </div>-->
</div>
</div>

docs(ui): update frontend README

refactor(ui): comment out notifications dash box (will use sidebar entry instead)