Skip to content

Commit e2c97b6

Browse files
committed
chore: Update Readme
1 parent 530549f commit e2c97b6

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,12 @@ STREAM_USER_ID=<Your user ID>
7777
STREAM_USER_TOKEN=<Your user token>
7878
```
7979

80+
Run `npm install` to install dependencies.
81+
8082
Run `npm start` and navigate to `http://localhost:4200/`.
8183

84+
Preferred Node version: v16.
85+
8286
## Customization examples
8387

8488
This repository includes a sample app that showcases how you can provide your own template for different components within the SDK:
@@ -93,14 +97,32 @@ STREAM_USER_ID=<Your user ID>
9397
STREAM_USER_TOKEN=<Your user token>
9498
```
9599

100+
Run `npm install` to install dependencies.
101+
96102
Run `npm start:customizations-example` and navigate to `http://localhost:4200/`.
97103

104+
Preferred Node version: v16.
105+
98106
## Local development
99107

108+
This repository includes a sample app to test our library.
109+
110+
To test the app:
111+
112+
Create a file named `.env` in the root directory with the following content:
113+
114+
```
115+
STREAM_API_KEY=<Your API key>
116+
STREAM_USER_ID=<Your user ID>
117+
STREAM_USER_TOKEN=<Your user token>
118+
```
119+
100120
Run `npm install` in the root of the project. You can use the `npm run start:dev` command to start the SampleApp with automatic reloading.
101121

102122
A note about the documentation:
103123

104124
- Documentations for Angular services are generated from doc comments in the source files (not under source control)
105125
- Documentations for inputs and outputs of Angular components are generated from doc comments in the source files (not under source control)
106126
- Everything else in the documentation is written in `mdx` files located in the `docusaurus` folder
127+
128+
Preferred Node version: v16.

0 commit comments

Comments
 (0)