From 8cc8a3a864c89193b6660b1778a6b98a5b4e382c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Uhl=C3=AD=C5=99?= Date: Tue, 13 May 2025 16:30:57 +0200 Subject: [PATCH] docs: api and more notes --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34db5b9..938b4ae 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Codex Factory +![render1747145157758-min](https://github.com/user-attachments/assets/0ebb6b42-88fc-4788-9027-a2ecb12eac1a) + [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/codex-factory.svg)](https://npmjs.org/package/codex-factory) [![Downloads/week](https://img.shields.io/npm/dw/codex-factory.svg)](https://npmjs.org/package/codex-factory) @@ -27,7 +29,7 @@ $ npm install -g codex-factory You can also use this CLI directly thanks to `npx` without installing it: ```shell -$ npx codex-factory start 0.2.0 +$ npx codex-factory start 0.2.1 ``` ## Usage @@ -80,6 +82,18 @@ There is special Codex Factory image tag `latest` that has the latest Codex's ma It is not recommended using this tag unless you need to test some upcoming feature and know what are you doing. There is high chance that there might be some change in Codex that is not compatible with current Codex Factory and so it might not even work. +## What it does + +This tool spawns small cluster of Codex nodes using Docker containers. +It spawns by default 5 nodes: 1 client node and 4 storage provider nodes. The cluster also contains local blockchain container that is running Hardhat instance with deployed Marketplace smart contracts and funds for all the nodes. All the nodes also run validator routine. All nodes run `persistence` module, so this is the most feature complete you can get with Codex. + +### Exposed API + +The API ports of the nodes are following: + + - `8080` for client node + - `8081-8084` for the host nodes + ## Contribute There are some ways you can make this module better: