From 27851208bd8a896fb6befb51157ec39c55959de2 Mon Sep 17 00:00:00 2001 From: Damien LACHAUME / PALO-IT Date: Tue, 30 Jan 2024 15:22:46 +0100 Subject: [PATCH] doc: add README file --- mithril-client-wasm/www-test/README.md | 29 ++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 mithril-client-wasm/www-test/README.md diff --git a/mithril-client-wasm/www-test/README.md b/mithril-client-wasm/www-test/README.md new file mode 100644 index 00000000000..04f7bfc24dc --- /dev/null +++ b/mithril-client-wasm/www-test/README.md @@ -0,0 +1,29 @@ +# Mithril client wasm: www-test + +* A set of tests for the Mithril client WASM library, which is a client for interacting with a Mithril network. The tests cover functionalities provided by the MithrilClient class. + +## Download source code + +```bash +# Download sources from github +git clone https://github.com/input-output-hk/mithril + +# Go to sources directory +cd mithril-client-wasm/ +``` + +* Before running the tests, make sure to install the required dependencies. Use the following command: + +```bash +make www-test-install +``` + +## Running the tests in the browser + +```bash +make www-test-serve +``` + +## Test Results Display + +The results of each test are displayed in the DOM dynamically. Open [http://localhost:8080](http://localhost:8080) with your browser. (port 8080 is the default port) \ No newline at end of file