agatha/api-playground
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update usage instruction

Browse Source
This commit is contained in:
agatha 2023-09-07 20:09:06 -04:00
parent a9e0e599f0
commit 3b75a8dc87
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,19 +4,23 @@ other HTTP-related code.
## Requirements ## Requirements
Requires either [Mockoon Desktop](https://mockcoon.com/download) or Requires either [Mockoon Desktop](https://mockcoon.com/download) or
[Mockoon CLI](https://hub.docker.com/r/mockoon/cli) [Mockoon CLI](https://hub.docker.com/r/mockoon/cli).
## Features ## Features
- JSON responses - JSON responses
- Randomized HTTP responses - Randomized HTTP responses
## Usage ## Usage
Import the environment file [mockoon-env.json](mockoon-env.json) into Mockcoon Desktop and click "Start Server".
For a more simple deployment use Docker:
```shell ```shell
docker compose up docker compose up
``` ```
Requests will be served at http://localhost:3000 unless another port is specified Requests will be served at http://localhost:3000 unless another port is specified
in the compose file. in the Mockcoon environment settings or the [docker-compose.yml](docker-compose.yml) file.
## Routes ## Routes