Skip to content

Commit bdc956c

Browse files
Merge pull request #454 from communitybridge/amolsontakke3576-patch-1
Update README.md
2 parents 9f40d53 + 1e9cceb commit bdc956c

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,43 @@ Once the CLA is signed, the GitHub pull request status is updated.
2929
Please see our [online product documentation](https://docs.linuxfoundation.org/lfx/v/v2/easycla) for a complete product
3030
overview.
3131

32+
## Prerequisites
33+
1. Make sure you have Node 12.x or higher, together with NPM 6.x or higher.
34+
2. Install `yarn` globally on your machine.
35+
36+
```bash
37+
$ npm install -g yarn
38+
```
39+
40+
3. Install `angular-cli` globally. (version 11).
41+
42+
```bash
43+
$ npm install -g @angular/cli
44+
```
45+
46+
## Installation
47+
48+
From the root of the repo just run:
49+
50+
```bash
51+
$ yarn install
52+
```
53+
54+
## Building
55+
56+
1. Run `yarn build` to build the project for your local environment.
57+
2. The build artifacts will be stored in the `dist/` directory.
58+
59+
## Running
60+
61+
1. Run `yarn serve --port 8100` (You can use any port but LFX header login/logout works only on port 8100)
62+
2. If you face any error while running the app use `export NODE_OPTIONS=--openssl-legacy-provider` command in the terminal before `yarn serve --port 8100`
63+
3. Open new browser window/tab with this link `https://localhost:8100/`.
64+
4. The app will automatically reload if you change any of the source files.
65+
66+
## Sample Local URL
67+
`http://localhost:8100/#/cla/project/projectId/user/userId?redirect=URL
68+
3269
## License
3370

3471
Copyright The Linux Foundation and each contributor to the LFX platform.

0 commit comments

Comments
 (0)