From b7ed2b718123029e98d127b344d67be800f345b8 Mon Sep 17 00:00:00 2001 From: Zita Szupera Date: Mon, 16 Dec 2024 11:56:30 +0100 Subject: [PATCH] chore: update install commands --- README.md | 3 +-- projects/stream-chat-angular/README.md | 37 +++++++++++++++++++++++--- 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9ba9190d..354bdb53 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,7 @@ Check out our current openings and apply via [Stream's website](https://getstrea Run this command if you are using **Angular 19**: ```shell -# Some SDK depedencies doesn't yet have official support for Angular 19, so we need to add --force flag until then -npm install stream-chat-angular stream-chat @ngx-translate/core@15 ngx-float-ui@18 --force +npm install stream-chat-angular stream-chat @ngx-translate/core@15 ngx-float-ui@19 ``` Supported Angular versions: **Angular 15-18** diff --git a/projects/stream-chat-angular/README.md b/projects/stream-chat-angular/README.md index 4bd29387..04f70d1d 100644 --- a/projects/stream-chat-angular/README.md +++ b/projects/stream-chat-angular/README.md @@ -51,16 +51,40 @@ Check out our current openings and apply via [Stream's website](https://getstrea ### Install with NPM -Run the following command if you are using **Angular 13**: +Run this command if you are using **Angular 19**: ```shell -npm install stream-chat-angular stream-chat @ngx-translate/core +npm install stream-chat-angular stream-chat @ngx-translate/core@15 ngx-float-ui@19 ``` -Run this command if you are using **Angular 12**: +Supported Angular versions: **Angular 15-18** + +Run this command if you are using **Angular 18**: + +```shell +npm install stream-chat-angular stream-chat ngx-float-ui@18 +``` + +Run this command if you are using **Angular 17**: ```shell -npm install stream-chat-angular stream-chat@5 @ngx-translate/core --legacy-peer-deps +npm install stream-chat-angular stream-chat ngx-float-ui@17 +``` + +Run this command if you are using **Angular 16**: + +```shell +npm install stream-chat-angular stream-chat ngx-float-ui@16 +``` + +Run this command if you are using **Angular 15**: + +```shell +npm install stream-chat-angular stream-chat @ngx-translate/core@14 ngx-float-ui@15 +``` + +Supported node verisons: 18+ + ``` ## Sample App @@ -72,9 +96,11 @@ To test the app: Create a file named `.env` in the root directory with the following content: ``` + STREAM_API_KEY= STREAM_USER_ID= STREAM_USER_TOKEN= + ``` Run `npm start` and navigate to `http://localhost:4200/`. @@ -88,9 +114,11 @@ To run the app: Create a file named `.env` in the root directory with the following content: ``` + STREAM_API_KEY= STREAM_USER_ID= STREAM_USER_TOKEN= + ``` Run `npm start:customizations-example` and navigate to `http://localhost:4200/`. @@ -98,3 +126,4 @@ Run `npm start:customizations-example` and navigate to `http://localhost:4200/`. ## Local development 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. +```