Skip to content

Commit 443b420

Browse files
committed
docs: Add introduction
1 parent 9943bc7 commit 443b420

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

introduction/introduction.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
The Angular Chat Messaging Component Library includes everything you need to build a fully functioning chat user experience in Angular with support for rich messages, reactions, image uploads and more. There are three important building blocks for Angular integration, we have made them available as npm packages:
2+
3+
- **Chat API client** - this is the interface between Chat rest APIs and your chat components, built using plain JavaScript. It makes it very easy to communicate with chat APIs e.g., sending a message, connecting to chat, creating channels etc.
4+
- Source - https://github.com/GetStream/stream-chat-js
5+
- npm - https://www.npmjs.com/package/stream-chat
6+
- **Angular Component SDK** - This provides ready-made UI components that can simply be plugged into your app without building your own UI components.
7+
- Source - https://github.com/GetStream/stream-chat-angular
8+
- npm - https://www.npmjs.com/package/stream-chat-angular
9+
- **Component styles** - We maintain a separate repository for the stylesheets of the web chat UI components.
10+
- Source - https://github.com/GetStream/stream-chat-css
11+
- npm - https://www.npmjs.com/package/stream-chat-css
12+
13+
We recommend you use our component SDK. Chat applications have a lot of moving parts and the Chat Component SDK handles all the stateful chat logic for you to make integration easy. Furthermore, the components offered are highly customisable allowing you to seamlessly incorporate your chat application into your existing application experience. That being said, for various reasons you may choose to build all of your chat UI components yourself, in which case you can still use our Component SDK and take adventage of the Angular services.
14+
15+
Before reviewing the Chat API docs, we recommend having a look at the [tutorial](https://getstream.io/tutorials/angular-chat/).
16+
17+
## Chat tutorial
18+
19+
TBD copy
20+
21+
## Conclusion
22+
23+
Now that you have basic understanding of the building blocks of our chat API, you can move on to Angular integration. The following resources should help you get started:
24+
25+
- [Angular chat tutorial](https://getstream.io/tutorials/angular-chat/)
26+
- [Component reference](https://getstream.io/chat/docs/sdk/angular/)
27+
28+
We would also recommend you to take a deep dive into our Chat API, by following next steps in navigation on left side.

0 commit comments

Comments
 (0)