Fix dev config designer user in catalog-ui

[sdc.git] / catalog-ui / README.md

diff --git a/catalog-ui/README.md b/catalog-ui/README.md
index c1f590a..39d5fca 100644 (file)
--- a/catalog-ui/README.md
+++ b/catalog-ui/README.md
@@ -5,8 +5,9 @@ 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
+To Specify the user role:
+
+npm start --env.role designer
 
 npm run <role>
 
@@ -20,8 +21,24 @@ 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.
+
+###webpack.server.js
+Development server is configured in `/webpack.server.js` file. Configure the constants accordingly:
+- const __devPort__: the webpack server port;
+- const __feHost__: the catalog front-end container host;
+- const __fePort__: the catalog front-end container port.
+
+The server will create a proxy to the front end calls based on the  __feHost__ and __fePort__. 
+It will also create authorization cookies to those requests. The cookies and user information comes from the 
+`/configurations/mock.json` file under the nodes `sdcConfig.cookie` and `sdcConfig.userTypes` respectively.
+The default user role is the node `sdcConfig.userTypes.designer` (configurable with the npm parameter --env.role).
+
+###
+
+###Application Configuration
+Application 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).