Yurujai / CryptoStats

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CryptoStats

CryptoStats it's a cryptocurrency exchange aggregator for local use.

  1. Installation

Before install you need to install docker-compose.

Step 1: Download code

git clone git@github.com:Yurujai/CryptoStats.git CryptoStats

Step 2: Go to the downloaded folder

cd CryptoStats

Step 3: Build docker

make build

Step 4: Start containers

make start

Step 5: Install dependencies

make install

Step 6: Clear cache

make cache

If you have an error after clear cache do the next lines:

docker exec -it php-fpm sh
chown -R www-data:www-data var
  1. Configuration

This project have .env file where you can modify some variables to set your API Keys.

IMPORTANT: Don't share your API Keys. It's most secure activate API for exchange on read mode. The software don't need more permission than read.

Step 1: Edit file .env

Step 2: Modify exchanges API keys.

### Exchanges APIs
BINANCE_ENABLED=false
BINANCE_API_KEY={yourBinanceAPIKey}
BINANCE_API_SECRET={yourBinanceAPISecret}

BITVAVO_ENABLED=false
BITVAVO_API_KEY={yourBitvavoAPIKey}
BITVAVO_API_SECRET={yourBitvavoAPISecret}

KUKOIN_ENABLED=false
KUKOIN_API_KEY={yourKukoinAPIKey}
KUKOIN_API_SECRET={yourKukoinAPISecret}

Step 3: Activate exchanges

To download and show your balances for an exchange you need to enable the exchange on the .env file

### Exchanges APIs
BINANCE_ENABLED=true
  1. How to access

To access the software execute the following lines on the terminal

docker inspect php-webserver

The output of this command will be like this

...
"Gateway": "xxx.xxx.xxx.xxx",
"IPAddress": "xxx.xxx.xxx.xxx",
"IPPrefixLen": xx,
...

Get the IP of the key IPAddress and put it on your web browser.

Enjoy!

Tips:

  1. How to remove all wallets ( to update platform )
{ip}/remove/wallets
  1. Add asset info to improve UI
docker exec -it php-fpm sh
php bin/console crypto:download:market:data

About


Languages

Language:PHP 64.6%Language:Twig 25.4%Language:CSS 3.9%Language:Dockerfile 2.6%Language:Shell 2.2%Language:Makefile 1.2%