Skip to content

Commit 8cc8a3a

Browse files
authored
docs: api and more notes
1 parent a2a0c58 commit 8cc8a3a

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Codex Factory
22

3+
![render1747145157758-min](https://github.com/user-attachments/assets/0ebb6b42-88fc-4788-9027-a2ecb12eac1a)
4+
35
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
46
[![Version](https://img.shields.io/npm/v/codex-factory.svg)](https://npmjs.org/package/codex-factory)
57
[![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
2729
You can also use this CLI directly thanks to `npx` without installing it:
2830

2931
```shell
30-
$ npx codex-factory start 0.2.0
32+
$ npx codex-factory start 0.2.1
3133
```
3234

3335
## Usage
@@ -80,6 +82,18 @@ There is special Codex Factory image tag `latest` that has the latest Codex's ma
8082
It is not recommended using this tag unless you need to test some upcoming feature and know what are you doing.
8183
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.
8284

85+
## What it does
86+
87+
This tool spawns small cluster of Codex nodes using Docker containers.
88+
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.
89+
90+
### Exposed API
91+
92+
The API ports of the nodes are following:
93+
94+
- `8080` for client node
95+
- `8081-8084` for the host nodes
96+
8397
## Contribute
8498

8599
There are some ways you can make this module better:

0 commit comments

Comments
 (0)