Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
janniks committed Jul 17, 2024
1 parent cc129ed commit 0f87c21
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@

> A repo for running functional tests on Stacks.
`src` consists of suites of tests that can be run independently against different network setups.
For example, we might run a suite against a full regtest, while another suite runs against clarinet, or another runs against live testnet.

## Local Docker

It's possible to run a local dockerized environment for testing using the `docker-compose.yml` file in the root of this repo.

## Regtest

It's possible to use this repo side-by-side with the Stacks regtest environment.

1. Setup the `regtest-env` folder next to this repo.
2. Run the regtest environment OR configure the ENV to automatically start/stop the regtest environment.
1. `REGTEST_DOWN_CMD` - The command to stop the regtest environment (e.g. `cd /regtest && docker compose down`).
2. `REGTEST_UP_CMD` - The command to start the regtest environment (e.g. `cd /regtest && docker compose up -d`).
1. `REGTEST_DOWN_CMD` - The command to stop the regtest environment (e.g. `cd /regtest && docker compose down`).
2. `REGTEST_UP_CMD` - The command to start the regtest environment (e.g. `cd /regtest && docker compose up -d`).
3. Run a test via Jest.

0 comments on commit 0f87c21

Please sign in to comment.