Skip to content

Commit d486229

Browse files
authored
Update README.md
1 parent a9ca595 commit d486229

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ npm install
1212
npm start
1313
```
1414

15+
## How to test
16+
17+
The API is tested using docker containers. I've only tested on MacOS so if you have experience testing on other platforms I'd love having these notes updated for those platforms.
18+
19+
### MacOS
20+
21+
First install [Docker Desktop for Mac](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
22+
23+
```bash
24+
npm run test-api
25+
```
26+
27+
This should build the appropriate containers and show the test output.
28+
29+
Our tests create mock API endpoints so we can verify rssCloud server works correctly when reading resources and notifying subscribers.
30+
1531
## How to use
1632

1733
### POST /pleaseNotify

0 commit comments

Comments
 (0)