You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With our component library, you can build a variety of chat use cases, including:
8
18
9
-
## Run sample app
19
+
- In-game chat like Overwatch or Fortnite
20
+
- Team-style chat like Slack
21
+
- Messaging-style chat like WhatsApp or Facebook's Messenger
22
+
- Customer support chat like Drift or Intercom
10
23
11
-
Run `npm install` before first start
24
+
## Angular Chat Tutorial
12
25
13
-
Set Stream credentials, see below
26
+
The best way to get started is to follow the [Angular Chat Tutorial](TBD). It shows you how to use this SDK to build a fully functional chat application and includes common customizations.
14
27
15
-
Run `npm start` and navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the sample app source files.
28
+
## Free for Makers
16
29
17
-
## Library development
30
+
Stream is free for most side and hobby projects. To qualify, your project/company must have no more than 5 team members and earn less than $10k in monthly revenue.
31
+
For complete pricing and details visit our [Chat Pricing Page](https://getstream.io/chat/pricing/).
18
32
19
-
Set Stream credentials, see below
33
+
## Installation
20
34
21
-
Run `npm run start:dev` it will start the sample app and watch for changes in the sample app or library source files.
This repository includes a sample app to test our library.
44
+
45
+
To test the app:
24
46
25
47
Create a file named `.env` in the root directory with the following content:
26
48
@@ -30,26 +52,21 @@ STREAM_USER_ID=<Your user ID>
30
52
STREAM_USER_TOKEN=<Your user token>
31
53
```
32
54
33
-
## Environment settings
34
-
35
-
Use the `set-env` script and `.env` file to set environment config for development
36
-
37
-
## Code scaffolding
38
-
39
-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
55
+
Run `npm start` and navigate to `http://localhost:4200/`.
40
56
41
-
## Lint
57
+
## Docs
42
58
43
-
Run `npm run lint`
59
+
The [docs](https://getstream.io/chat/docs/sdk/angular/) provide a brief description about the components and services in the library.
44
60
45
-
## Build
61
+
The Angular library is created using the [stream-chat-js](https://github.com/getstream/stream-chat-js) library. For the most common use cases our services should give a nice abstraction over this library, however you might need it for more advanced customization, the [documentation](https://getstream.io/chat/docs/js/) is on our website.
46
62
47
-
Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory.
63
+
## Contributing
48
64
49
-
## Running unit tests
65
+
We welcome code changes that improve this library or fix a problem. Please make sure to follow all best practices and add tests, if applicable, before submitting a pull request on GitHub. We are pleased to merge your code into the official repository if it meets a need. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
50
66
51
-
Run `npm run test` to execute the unit tests of the library via [Karma](https://karma-runner.github.io).
67
+
## We are hiring!
52
68
53
-
## Running end-to-end tests
69
+
We recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and are actively growing.
70
+
Our APIs are used by more than a billion end-users, and by working at Stream, you have the chance to make a huge impact on a team of very strong engineers.
54
71
55
-
Run `npm run e2e` to execute the end-to-end tests of the sample app via Cypress.
72
+
Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).
# Official Angular SDK for [Stream Chat](https://getstream.io/chat/sdk/react/)
2
2
3
-
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.2.0.
3
+
> The official Angular components for Stream Chat, a service for building chat applications.
4
4
5
-
## Code scaffolding
5
+
6
6
7
-
Run `ng generate component component-name --project stream-chat-angular` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project stream-chat-angular`.
Run `ng build stream-chat-angular` to build the project. The build artifacts will be stored in the `dist/` directory.
17
+
With our component library, you can build a variety of chat use cases, including:
14
18
15
-
## Publishing
19
+
- In-game chat like Overwatch or Fortnite
20
+
- Team-style chat like Slack
21
+
- Messaging-style chat like WhatsApp or Facebook's Messenger
22
+
- Customer support chat like Drift or Intercom
16
23
17
-
After building your library with `ng build stream-chat-angular`, go to the dist folder `cd dist/stream-chat-angular` and run `npm publish`.
24
+
## Angular Chat Tutorial
18
25
19
-
## Running unit tests
26
+
The best way to get started is to follow the [Angular Chat Tutorial](TBD). It shows you how to use this SDK to build a fully functional chat application and includes common customizations.
20
27
21
-
Run `ng test stream-chat-angular` to execute the unit tests via [Karma](https://karma-runner.github.io).
28
+
## Free for Makers
22
29
23
-
## Further help
30
+
Stream is free for most side and hobby projects. To qualify, your project/company must have no more than 5 team members and earn less than $10k in monthly revenue.
31
+
For complete pricing and details visit our [Chat Pricing Page](https://getstream.io/chat/pricing/).
24
32
25
-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
This repository includes a sample app to test our library.
44
+
45
+
To test the app:
46
+
47
+
Create a file named `.env` in the root directory with the following content:
48
+
49
+
```
50
+
STREAM_API_KEY=<Your API key>
51
+
STREAM_USER_ID=<Your user ID>
52
+
STREAM_USER_TOKEN=<Your user token>
53
+
```
54
+
55
+
Run `npm start` and navigate to `http://localhost:4200/`.
56
+
57
+
## Docs
58
+
59
+
The [docs](https://getstream.io/chat/docs/sdk/angular/) provide a brief description about the components and services in the library.
60
+
61
+
The Angular library is created using the [stream-chat-js](https://github.com/getstream/stream-chat-js) library. For the most common use cases our services should give a nice abstraction over this library, however you might need it for more advanced customization, the [documentation](https://getstream.io/chat/docs/js/) is on our website.
62
+
63
+
## Contributing
64
+
65
+
We welcome code changes that improve this library or fix a problem. Please make sure to follow all best practices and add tests, if applicable, before submitting a pull request on GitHub. We are pleased to merge your code into the official repository if it meets a need. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
66
+
67
+
## We are hiring!
68
+
69
+
We recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and are actively growing.
70
+
Our APIs are used by more than a billion end-users, and by working at Stream, you have the chance to make a huge impact on a team of very strong engineers.
71
+
72
+
Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).
0 commit comments