appengine/config_service/ui/README.md - Issue 2985493002: config_service: README update

Unified Diff: appengine/config_service/ui/README.md

Issue 2985493002: config_service: README update (Closed)

Patch Set: Created 3 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Index: appengine/config_service/ui/README.md

diff --git a/appengine/config_service/ui/README.md b/appengine/config_service/ui/README.md

index c938e6be3f3e2944827b59b92bf6cb7fa26e208b..af5e59eaea9fc09d38aafa32cd384c9c91e06828 100644

--- a/appengine/config_service/ui/README.md

+++ b/appengine/config_service/ui/README.md

@@ -1,38 +1,34 @@

-# \<Config UI\>

+# LUCI Config UI

-This is a UI for the configuration service

+This is a UI for the configuration service.

-## Install the Polymer-CLI

-First, make sure you have the [Polymer CLI](https://www.npmjs.com/package/polymer-cli) installed. Then run `polymer serve` to serve your application locally.

+## Setting up

Ryan Tseng 2017/07/19 20:53:36 I think the appengine SDK also needs to be install

ayanaadylova 2017/07/19 21:12:47 Done.

-## Viewing Your Application

+* First, make sure you have the [Polymer CLI](https://www.polymer-project.org/2.0/docs/tools/polymer-cli) installed.

-```

-$ polymer serve

-```

+* Run 'bower install' to make sure you have all the dependecies installed.

Ryan Tseng 2017/07/19 20:53:36 in which directory? Also use backtick ` instead o

ayanaadylova 2017/07/19 21:12:47 Done.

-## Building Your Application

-```

-$ polymer build

-```

+## Running locally

-This will create builds of your application in the `build/` directory, optimized to be served in production. You can then serve the built versions by giving `polymer serve` a folder to serve from:

+* First, change all the URLs in the iron-ajax calls. Simply add "https://luci-config.appspot.com" before each URL.

+ * One in the src/config-ui/front-page.html

Ryan Tseng 2017/07/19 20:53:36 ** instead of <tab>*

ayanaadylova 2017/07/19 21:12:47 ** doesn't work, so I used <tab>* instead.

+ * Two in the src/config-ui/config-set.html

-```

-$ polymer serve build/default

-```

+* In the config-service folder run 'dev_appserver.py app.yaml'

Ryan Tseng 2017/07/19 20:53:36 `dev_appserver.py app.yaml` it's a backtick inste

ayanaadylova 2017/07/19 21:12:47 Done.

+* Visit "http://localhost:8080"

-## Running Tests

-```

-$ polymer test

-```

+## Running Tests

-Your application is already set up to be tested via [web-component-tester](https://github.com/Polymer/web-component-tester). Run `polymer test` to run your application's test suite locally.

+* Your application is already set up to be tested via [web-component-tester](https://github.com/Polymer/web-component-tester).

+ Run 'wct, 'wct -p' or 'polymer test' inside ui folder to run your application's test suites locally.

+ These commands will run tests for all browsers installed on your computer.

## Third Party Files

-In order to use proper authentication, the google-signin-aware element was needed. However, this element has not been updated to Polymer 2.0, so edits were made to the current version to ensure compatibility.

+In order to use proper authentication, the google-signin-aware element was needed. However, this element has not been updated to

+Polymer 2.0, so edits were made to the current version to ensure compatibility.

The modified google-signin-aware element can be found in the ui/common/third_party/google-signin folder.

« no previous file with comments | « no previous file | no next file » | no next file with comments »