Skip to content

Commit

Permalink
update readme (#9)
Browse files Browse the repository at this point in the history
* update readme

* docker compose
  • Loading branch information
dtinth authored Oct 9, 2024
1 parent 375c07c commit 50c36b7
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Contributions for more APIs are welcome!
| [**LINE**](https://mockapis.onrender.com/swagger#tag/line) | A mock API that implements a subset of the [LINE Messaging API](https://developers.line.biz/en/reference/messaging-api/). |
| [**Vonage**](https://mockapis.onrender.com/swagger#tag/vonage) | A mock API that implements a subset of the [Vonage SMS API](https://developer.vonage.com/en/api/sms) for sending SMS messages. |
| [**dtinth/kio**](https://mockapis.onrender.com/swagger#tag/dtinthkio) | A mock API that implements the endpoints expected by [dtinth/kio](https://github.com/dtinth/kio), a geeky self-checkin kiosk. |
| [**OpnPayments**](https://mockapis.onrender.com/swagger#tag/opnpayments) | A mock API that implements a subset of the [OpnPayments API](https://docs.opn.ooo) for receiving payments. |
| [**SMSKUB**](https://mockapis.onrender.com/swagger#tag/smskub) | A mock API that implements a subset of the [SMSKUB API](https://documenter.getpostman.com/view/9887776/VV4xvFoy#6cfa0c23-5f08-4f80-9e62-ffbf10dd75ea) for sending SMS quick messages. |

<!-- end api list -->

Expand All @@ -42,12 +44,42 @@ You can explore the available APIs and their documentation at our demo instance:

## Running with Docker

We provide a docker-compose configuration for users who would like to run the service locally without any configuration. This is useful if you have limitation connecting to external network during testing.
### Using Pre-built Image

For quick setup without building from source, you can use the pre-built Docker image. Create a `docker-compose.yml` file with the following content:

```yaml
services:
redis:
image: "redis:latest"
mockapis:
image: ghcr.io/dtinth/mockapis:main
environment:
- REDIS_URL=redis://redis:6379
depends_on:
- redis
ports:
- "46982:46982"
```
Then run:
```sh
docker compose up -d
```

This will start the Mock APIs service using the latest pre-built image from the GitHub Container Registry.

### Building from Source

If you plan to make changes to the Mock APIs or want to build from source, you can use the `docker-compose.yml` file provided in the repository. Clone the repository and run:

```sh
docker compose up -d
```

This will build the Docker image from the source code in the repository and start the service.

## Features

- Multiple mock API endpoints simulating various services without the need for authentication or API keys (any key is accepted)
Expand Down

0 comments on commit 50c36b7

Please sign in to comment.