ae/chainmapper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: additional clarifications about the usage guides

Browse Source
This commit is contained in:
17ms 2024-07-12 23:10:20 +03:00
parent 8462ab866c
commit 9e8aabdba3
Signed by untrusted user who does not match committer: ae
GPG Key ID: 995EFD5C1B532B3E
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -4,6 +4,8 @@ Script that, once deployed in a Docker container, monitors a live feed of the Et
## Development
Most critically `MODE=development` should be specified, as it sets the logging level from `INFO` to `DEBUG`. Low `EXPORT_INTERVAL` should be used for testing the export functionality (obviously).
```shell
mkvirtualenv chainmapper # OR 'workon chainmapper'
pip3 install -r requirements.txt
@ -12,6 +14,8 @@ touch .env && echo -e "MODE=\"development\"\nEXPORT_INTERVAL=\"60\"" > .env # 60
## Usage
The included `usage.sh` shellscript should be used for any kind of (development or production) deployment. It builds a new Docker image without caching, prompts for removal of any possible conflicting containers, and finally deploys the newly built image as a container with the `data/` local directory mounted as a volume.
```shell
chmod +x ./scripts/deploy.sh
./scripts/deploy.sh