add some simple docs

pull/13/head
lza_menace 3 years ago
parent 76b5da9790
commit a2b3d3a385

@ -1,6 +1,7 @@
setup: setup:
python3 -m venv .venv python3 -m venv .venv
.venv/bin/pip install -r requirements.txt .venv/bin/pip install -r requirements.txt
mkdir data
wget https://github.com/P3TERX/GeoLite.mmdb/raw/download/GeoLite2-City.mmdb -P data wget https://github.com/P3TERX/GeoLite.mmdb/raw/download/GeoLite2-City.mmdb -P data
up: up:

@ -1,3 +1,34 @@
# monero.fail # monero.fail
Monero node tracker Monero node tracker
## Setup
Tools you will need:
* Docker # apt-get install docker.io
* docker-compose # apt-get install docker-compose
* python3 (linux os will have this)
* python3-venv # apt-get install python3-venv
### Development
I have provided a `Makefile` with some helpful stuff...make sure to install `make` to use it.
The map portion of the service requires the GeoLite2 db...the `make setup` command fetches a copy via `wget`.
```
# install python virtual environment and install application dependencies
make setup
# setup config
cp xmrnodes/config.example.py xmrnodes/config.py
vim xmrnodes/config.py
# run services (tor, i2p, etc)
make up
# run development server
make dev
# access at http://127.0.0.1:5000
```

Loading…
Cancel
Save