Skip to content

Commit

Permalink
chore: update DEVREADME
Browse files Browse the repository at this point in the history
Signed-off-by: Jason C. Leach <[email protected]>
  • Loading branch information
jleach committed Feb 15, 2023
1 parent a6682de commit f684ad8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .devcontainer/devcontainer.env
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
# Any environment variables that the container needs
# go in here.
#
# Example(s)
# GENESIS_TXN_PATH=network/genesis/local-genesis.txn
#
6 changes: 6 additions & 0 deletions DEVREADME.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This file is intended for developers working on the internals of the framework. If you're just looking how to get started with the framework, see the [docs](./docs)

# Environment Setup

## VSCode devContainer

This project comes with a [.devcontainer](./devcontainer) to make it as easy as possible to setup your dev environment and begin contributing to this project. All the [environment variables](https://code.visualstudio.com/remote/advancedcontainers/environment-variables) noted below can be added to [devcontainer.env](./devcontainer.env) and exposed to the development docker container.

## Running tests

Test are executed using jest. Some test require either the **mediator agents** or the **ledger** to be running. When running tests that require a connection to the ledger pool, you need to set the `TEST_AGENT_PUBLIC_DID_SEED` and `GENESIS_TXN_PATH` environment variables.
Expand Down

0 comments on commit f684ad8

Please sign in to comment.