Contributing

How to contribute

• If you find solution to an issue/improvements in sdk that would be helpful to everyone, feel free to send us a pull request.
• The best help we could get from everyone is in writing more and more samples. We have a limited set of samples, and would appreciate if the community can help us write more and more of those, covering corner cases, that may be extremely useful to anyone using this SDK.
• The ideal approach to create a fix would be to fork the repository, create a branch in your repository, and make a pull request out of it.
• It is desirable if there is enough comments/documentation and Tests included in the pull request.
• For general idea of contribution, please follow the guidelines mentioned here.

Setting up a development machine

Ubuntu 14.04

apt-get install php5
sudo apt-get install curl
sudo apt-get install php5-curl
sudo apt-get install php5-gmp
sudo apt-get install php5-mcrypt
sudo php5enmod mcrypt
service apache2 restart
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer
mkdir BlockCypher
git clone https://github.com/blockcypher/php-client.git
cd php-client
php -f ./sample/address-api/GetAddress.php

Generate API Documentation

PHP client uses apigen to generate API documentation.

You can download apigen.phar to php-client root folder and run:

php apigen.phar generate --template-theme="bootstrap" -s lib -d ../gh-pages/docs

to generate API source docs

Self-generate documentation for samples

PHP client uses groc to generate documentation for samples.

You can generate docs for all samples running this command on the sample folder:

cd ./sample
groc */*.php

Samples documentation in generated in ./sample/doc/SAMPLE_PATH.html

You will need install nodejs and groc. Groc installation:

npm install -g groc

More info about groc installation.