Skip to content
This repository was archived by the owner on Jan 27, 2026. It is now read-only.

Commit 3c7aabf

Browse files
authored
improve development setup doc (#595)
1 parent bb3d80b commit 3c7aabf

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

docs/development-setup.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ git submodule update --init --recursive
3636
# Install Foundry
3737
curl -L https://foundry.paradigm.xyz | bash
3838

39-
# Reload .bashrc (or .bash_profile, depends on the system)
39+
# Reload your shell environment
4040
source ~/.bashrc
4141

4242
foundryup
@@ -47,6 +47,9 @@ foundryup
4747
# Install Rust
4848
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
4949

50+
# Reload your shell environment
51+
source ~/.bashrc
52+
5053
# Install cargo-watch
5154
cargo install cargo-watch
5255
```
@@ -57,6 +60,7 @@ cargo install cargo-watch
5760
brew install redis
5861

5962
# Install Redis (Ubuntu)
63+
sudo apt-get update
6064
sudo apt-get install redis-server
6165
```
6266

@@ -80,10 +84,9 @@ sudo apt-get install libssl-dev
8084
```bash
8185
sudo usermod -aG docker $USER
8286
```
83-
- Create `.env` files in base folder and discovery folder
8487

8588
### 4. Launch Core Services
86-
- Copy the `.env.example` file
89+
- Copy the `.env.example` file to `.env`
8790
```bash
8891
make up
8992
```
@@ -102,11 +105,14 @@ Once the core services are running, you can start a worker node in a new termina
102105
```bash
103106
make watch-worker
104107
```
108+
Your worker will show an error indicating it is not whitelisted yet. You'll need to run `make whitelist-provider` to resolve this.
109+
110+
You should see your worker appear on the orchestrator. You can also check the orchestrator documentation at: `http://localhost:8090/docs`
105111

106-
The worker will automatically connect to the discovery service and begin processing tasks.
107-
Your worker will show an error that it is not whitelisted yet. You'll have to run `make whitelist-provider` here.
108-
It takes a couple of seconds until the worker is whitelisted. This is done using a simple loop on the second page of tmux.
109-
You should see your worker eventually on the orchestrator. Checkout the orchestrator doc also: `http://localhost:8090/docs`
112+
Quick check in the api of the orchestrator:
113+
```bash
114+
curl -H "Authorization: Bearer admin" http://localhost:8090/nodes
115+
```
110116

111117
## Remote GPU Development
112118
> ⚠️ **IMPORTANT**: The video shows the whitelist process happening automatically. Currently, this must be done manually using the command `make whitelist-provider`.

0 commit comments

Comments
 (0)