Skip to content

Commit f91ba7b

Browse files
committed
fix(docs): Update README instruction to setting up local network and running tests
1 parent 6123ed2 commit f91ba7b

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

contrib/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ The current implementation leverages local-network for the common services and u
1111

1212
We provide the following Make/Just commands to streamline your development workflow:
1313

14-
- `make setup` - Full setup of all services, dependencies and binary compilation
15-
- `make reload` - Rebuild Rust binaries and restart services after code changes
16-
- `make logs` - Watch log output from all services
17-
- `make down` - Stop all services
18-
- `make rav_tests` - Run integration tests against local services
14+
- `just setup` - Full setup of all services, dependencies and binary compilation
15+
- `just reload` - Rebuild Rust binaries and restart services after code changes
16+
- `just logs` - Watch log output from all services
17+
- `just down` - Stop all services
18+
- `just test-local` - Run integration tests against local services
1919

2020
## Initial Setup
2121

@@ -25,7 +25,7 @@ To get started with development:
2525
2. Run the full setup to initialize all services:
2626

2727
```bash
28-
make setup
28+
just setup
2929
```
3030

3131
This will:
@@ -43,7 +43,7 @@ After the initial setup, you can use the fast development workflow:
4343
2. Run the reload command to rebuild and restart indexer and tap-agent services:
4444

4545
```bash
46-
make reload
46+
just reload
4747
```
4848

4949
This workflow is much faster because:
@@ -70,7 +70,7 @@ This approach avoids the time-consuming container rebuild process while still ma
7070
To monitor the services during development:
7171

7272
```bash
73-
make logs
73+
just logs
7474
```
7575

7676
This will show a live stream of logs from all services, which is useful for debugging.
@@ -80,7 +80,7 @@ This will show a live stream of logs from all services, which is useful for debu
8080
To run integration tests against your local environment:
8181

8282
```bash
83-
make rav_tests
83+
just local-test
8484
```
8585

8686
This is currently a work in progress, and additional testing strategies are still being defined and implemented.
@@ -90,7 +90,7 @@ This is currently a work in progress, and additional testing strategies are stil
9090
When you're done working:
9191

9292
```bash
93-
make down
93+
just down
9494
```
9595

9696
This will stop and remove all the containers defined in the docker-compose file.

setup-test-network.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ set -e
1111
# to stop all services before running this script again
1212
#
1313
# - To test changes to your indexer code without restarting everything:
14-
# make reload
14+
# just reload
1515
#
1616
# - The script checks for existing services and skips those already running
1717
# ==============================================================================
@@ -38,10 +38,10 @@ container_running() {
3838
if container_running "indexer-service" && container_running "tap-agent" && container_running "gateway"; then
3939
echo "====================================================================================="
4040
echo "All services are already running. To test changes to your indexer code, you can use:"
41-
echo " make reload - To rebuild and restart just indexer-service tap-agent services"
41+
echo " just reload - To rebuild and restart just indexer-service tap-agent services"
4242
echo ""
4343
echo "If you need to start from scratch, first stop all services with:"
44-
echo " make down"
44+
echo " just down"
4545
echo " docker rm -f indexer-service tap-agent gateway"
4646
echo "====================================================================================="
4747
exit 0

0 commit comments

Comments
 (0)