Skip to content

Commit

Permalink
Add docker info in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
evgeny-stakewise committed Nov 13, 2024
1 parent 25dc5b1 commit e9d1fe1
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,6 @@ cython_debug/
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
.idea/

.vscode
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,36 @@ DVT sidecar:
2. Polls validator exits from Relayer
3. Pushes exit signature shares to Relayer on behalf of DVT operators.

## Setup
## Run in docker

1. `cp .env.example .env`
2. Fill .env file with appropriate values
3. Run container

```shell
docker run \
-u $(id -u):$(id -g) \
--env-file .env \
-v $(pwd)/data:/data \
europe-west4-docker.pkg.dev/stakewiselabs/public/dvt-operator-sidecar:v0.4.2
```

## Development

### Setup

1. Install [poetry](https://python-poetry.org/)
2. `poetry install`
3. `cp .env.example .env`
4. Fill .env file with appropriate values

## Run
### Run

1. `poetry shell`
2. `export PYTHONPATH=.`
3. `python src/app.py`

## Testing
### Testing

This section is about integration testing, when sidecar works in conjunction with DVT Relayer and Stakewise Operator.

Expand Down

0 comments on commit e9d1fe1

Please sign in to comment.