summaryrefslogtreecommitdiffstats
path: root/catalog-ui/README.md
diff options
context:
space:
mode:
authorMichael Lando <ml636r@att.com>2017-06-09 03:19:04 +0300
committerMichael Lando <ml636r@att.com>2017-06-09 03:19:04 +0300
commited64b5edff15e702493df21aa3230b81593e6133 (patch)
treea4cb01fdaccc34930a8db403a3097c0d1e40914b /catalog-ui/README.md
parent280f8015d06af1f41a3ef12e8300801c7a5e0d54 (diff)
[SDC-29] catalog 1707 rebase commit.
Change-Id: I43c3dc5cf44abf5da817649bc738938a3e8388c1 Signed-off-by: Michael Lando <ml636r@att.com>
Diffstat (limited to 'catalog-ui/README.md')
-rw-r--r--catalog-ui/README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/catalog-ui/README.md b/catalog-ui/README.md
new file mode 100644
index 0000000000..c1f590a946
--- /dev/null
+++ b/catalog-ui/README.md
@@ -0,0 +1,39 @@
+# CatalogUi
+
+## Development server
+Run "npm start" for a dev server.
+Navigate to "http://localhost:9000/".
+The app will automatically reload if you change any of the source files.
+
+--- Specify role ---
+npm start -- --env.role designer
+
+npm run <role>
+
+## Build
+--- dev ---
+Run "npm run build" to build the project.
+The build artifacts will be stored in the `dist/` directory.
+
+--- prod ---
+Run "npm run build:prod" to build the project.
+The build artifacts will be stored in the `dist/` directory.
+
+## Configuration
+Dev server is configured in webpack.server.js file.
+App configuration dev.js or prod.js and menu.js are located in configuration folder and required by app.ts according to __ENV__ parameter from webpack.
+
+## Running unit tests
+## Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Running end-to-end tests
+## Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+## Before running the tests make sure you are serving the app via `ng serve`.
+
+-- Working with WebStorm --
+
+go to File --> Settings --> Languages & Frameworks
+
+Under JavaScript -> set JavaScript language version to ECMAScript6
+Under TypeScript -> select 'Enable TypeScript Compiler' and choose 'Use tsconfige.json'
+