summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoreschcam <cameron.scholes@est.tech>2022-11-14 17:05:55 +0000
committerCameron Scholes <cameron.scholes@est.tech>2022-11-15 14:23:37 +0000
commit990bd0f9e2d4ee80be782e66af60de5271b21d95 (patch)
treedda0f0ba8d54a6b1bc591a84a17ccded7144c219
parent3d540b3bd4492ba0682c6621c3640a0d1f6b14b8 (diff)
Fix formatting of Catalog-UI Readme
Made formatting adjustment to the README.md file inside the Catalog-UI project folder Issue-ID: SDC-4261 Change-Id: Ic844443baa9802889d714329da5ae38377a8b76e Signed-off-by: eschcam <cameron.scholes@est.tech>
-rw-r--r--catalog-ui/README.md44
1 files changed, 25 insertions, 19 deletions
diff --git a/catalog-ui/README.md b/catalog-ui/README.md
index 39d5fca1e8..9892af9e5b 100644
--- a/catalog-ui/README.md
+++ b/catalog-ui/README.md
@@ -1,56 +1,62 @@
# 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.
+1. Run `npm start` for a dev server.
+2. Navigate to <http://localhost:9000/>.
+ * The app will automatically reload if you change any of the source files.
+
To Specify the user role:
-npm start --env.role designer
+`npm start --env.role designer`
+
+`npm run <role>`
-npm run <role>
## Build
---- dev ---
-Run "npm run build" to build the project.
+### 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.
+
+### prod
+Run `npm run build:prod` to build the project.
+
The build artifacts will be stored in the `dist/` directory.
## Configuration
-###webpack.server.js
+### 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
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).
+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`.
+Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
--- Working with WebStorm --
+Before running the tests make sure you are serving the app via `ng serve`.
-go to File --> Settings --> Languages & Frameworks
+## Working with WebStorm
-Under JavaScript -> set JavaScript language version to ECMAScript6
-Under TypeScript -> select 'Enable TypeScript Compiler' and choose 'Use tsconfige.json'
+1. go to File --> Settings --> Languages & Frameworks
+2. Under JavaScript -> set JavaScript language version to ECMAScript6
+3. Under TypeScript -> select `Enable TypeScript Compiler` and choose `Use tsconfige.json`