Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add ml-testing-toolkit documentation #235

Merged
merged 5 commits into from
Jul 2, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
* [Scheme Adapter to Scheme Adapter](mojaloop-technical-overview/sdk-scheme-adapter/usage/scheme-adapter-to-scheme-adapter/README.md)
* [Scheme Adapter to Local ML Cluster](mojaloop-technical-overview/sdk-scheme-adapter/usage/scheme-adapter-and-local-k8s/README.md)
* [Scheme Adapter to WSO2 API Gateway](mojaloop-technical-overview/sdk-scheme-adapter/usage/scheme-adapter-and-wso2-api-gateway/README.md)
* [ML Testing Toolkit](mojaloop-technical-overview/ml-testing-toolkit/README.md)
* [API Specifications](api/README.md)
* [Mojaloop](api/mojaloop-api-specification.md)
* [Central Ledger API](api/central-ledger-api-specification.md)
Expand Down
15 changes: 15 additions & 0 deletions mojaloop-technical-overview/ml-testing-toolkit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Mojaloop Testing Toolkit
=============================

The **Mojaloop Testing Toolkit** was designed for participants that would like to participate in the Mojaloop scheme. Intentionally build as a standard integration testing tool between a _Digital Financial Service Provider (DFSP)_ and the _Mojaloop Switch_ (Hub), to facilitate testing. This tool set can potentially be used by both the DFSP and the _Mojaloop Switch_ to verify the integration between the 2 entities.
elnyry-sam-k marked this conversation as resolved.
Show resolved Hide resolved

For additional back ground information on the Self Testing Toolkit, please see [Mojaloop Testing Toolkit](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/Mojaloop-Testing-Toolkit.md). It would be to the particpant's benefit to familiarise themselves with the understanding of the [Architecture Diagram](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/Mojaloop-Testing-Toolkit.md#7-architecture) that explains the various components and related flows.
elnyry-sam-k marked this conversation as resolved.
Show resolved Hide resolved

## Usage Guides

For Web interface follow this [Usage Guide](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/User-Guide.md)

For Command line tool follow this [CLI User Guide](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/User-Guide-CLI.md)


****If you have your own DFSP implementation you can point the peer endpoint to **Mojaloop Testing Toolkit** on port 5000 and try to send requests from your implementation instead of using mojaloop-simulator.**
georgi-logodazhki marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "documentation",
"version": "10.5.0",
"version": "10.5.1",
"description": "Mojaloop Documentation GitBook Project",
"dependencies": {
"express": "4.17.1",
Expand Down