Skip to content

Commit 64195bd

Browse files
committed
docs: update intro in README.md
1 parent 2683801 commit 64195bd

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
11
# angular-spring-rsocket-sample
2-
Demo for using Angular and Spring RSocket together
2+
3+
This sample is to demonstrate a chat application using the following cutting-edge technology stack :
4+
5+
* Angular as client which uses `rsocket-js` to communicate with the server side
6+
* Spring WebFlux based RSocket server which uses WebSocket as transport protocol
7+
* Spring Data MongoDB based `@Tailable` query result as an infinite stream
8+
9+
## Build
10+
11+
Before running the application, you should build and run client and server side respectively.
12+
13+
### Server
14+
15+
Run a MongoDB service firstly, simply you can run it from a Docker container. There is a `docker-compose.yaml` file is ready for you.
16+
17+
```bash
18+
docker-compose up mongodb
19+
```
20+
21+
Build the application.
22+
23+
```e
24+
./gradlew build
25+
```
26+
27+
Run the target jar from the *build* folder to start up the application.
28+
29+
```bash
30+
java -jar build/xxx.jar
31+
```
32+
33+
### Client
34+
35+
Install dependencies.
36+
37+
```bash
38+
npm install
39+
```
40+
41+
Start up the application.
42+
43+
```bash
44+
npm run start
45+
```
46+
47+
Open a browser and navigate to http://localhost:4200.
48+
49+
50+
## Reference
51+
52+
* [rsocket-js samples](https://github.com/rsocket/rsocket-js/blob/master/packages/rsocket-examples)

0 commit comments

Comments
 (0)