Skip to content

Commit a628be0

Browse files
committed
README.md
1 parent 2b29cd4 commit a628be0

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

live-event-app/README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
11
# Live Event App
22

3-
The purpose of this application is to simulate the high-volume use case. This use case means getting thousands of messages for one channel in a very short time.
3+
The purpose of this application is to simulate possible use cases that require iOS Chat Components to wokr under heavy load.
44

55
## Prerequisites
66

77
| Name | Requirement |
88
| :--- | :------ |
99
| [Xcode](https://developer.apple.com/xcode/resources/) | >= 13.0 |
10-
| [@pubnub/tomato](https://github.com/pubnub/tomato) | >= 1.5.0 |
10+
| [npm](https://www.npmjs.com/) | >= 19.1.0 |
1111

1212
## Usage
1313

14-
### First step
14+
1. Install the `npm` package manager. For instance, you can do it using [Homebrew](https://brew.sh/):
1515

16-
1. ...
16+
```
17+
brew install npm
18+
```
1719

18-
2. ...
20+
1. Go to the `tomato` directory and execute the `npm install` command in the Terminal application
1921

20-
3. ...
22+
2. Run the mock server by executing `npx tomato`
2123

22-
## Support
24+
3. See the [list of contracts](#contracts) below and their purposes.
2325

24-
If you need help or have a general question, [contact support](mailto:support@pubnub.com).
26+
4. Load a contract in a separate Terminal window (from the same location) as follows (where `###` is a contract name you'd like to use):
27+
28+
```
29+
curl -v 'http://localhost:8090/init?__contract__script__=###'
30+
```
31+
32+
5. Run the `live-event-app` target on any simulator
33+
34+
## Contracts
35+
36+
All contract files are stored in the `tomato/contracts` directory:
37+
38+
| Name | Implementation | Use case |
39+
|----- |--------- |---------- |
40+
| `loadTest` | `load-test-1.ts` | Simulates receiving thousands of messages from multiple users |
2541

2642
## License
2743

0 commit comments

Comments
 (0)