README.md

openclerk

NOTE: This project is no longer actively maintained, but we will still accept patches and contributions. We are now working on cryptfolio.com; a modern, rebuilt cryptocurrency tracking platform, with mobile apps, source code access, and more. Check it out!

An open source project to keep track of cryptocurrency finances, based on an internal prototype.

Requires PHP 5.4+ and uses a number of awesome child components:

• openclerk/db for database abstraction
• openclerk/emails for email management
• openclerk/config for configuration management
• openclerk/events for server-side event management
• openclerk/routing and openclerk/templates for page routing and templating
• openclerk/currencies for abstract currency definitions
• openclerk/cryptocurrencies for cryptocurrency definitions
• soundasleep/component-discovery and soundasleep/asset-discovery for runtime component and asset discovery, enabling custom extensions

Features

List of features that are also running at https://cryptfolio.com:

• Easy-to-use web interface based in PHP
• Create free accounts through OpenID or passwords
• Support for multiple currencies
  • Cryptocurrencies (BTC, LTC, NMC, PPC, FTC, XPM, NVC, TRC, DOGE, MEC, XRP, DGC, WDC, IXC, VTC, NET, BLK, HBN, DRK, VRC, NXT, RDD, VIA, NBT, NSR, SJCX)
  • Fiat currencies (USD, GBP, EUR, CAD, AUD, NZD, CNY, PLN, ILS, KRW, SGD, DKK, INR)
  • Commodity currencies (GHS)
• Support for exchange wallets
  • ANXPRO
  • Bit2c
  • BitMarket.pl
  • BitNZ
  • Bitstamp
  • Bittrex
  • BTC-e
  • BTCLevels
  • CEX.io
  • Coinbase
  • Cryptsy
  • Justcoin
  • Kraken
  • Poloniex
  • Vircurex
• Support for currency exchanges
  • ANXPRO
  • Bit2c
  • Bitcurex
  • BitMarket.pl
  • BitNZ
  • Bitstamp
  • Bittrex
  • BTCChina
  • BTC-e
  • BTER
  • CEX.io
  • Coinbase
  • Coins-E
  • Cryptsy
  • itBit
  • Kraken
  • Poloniex
  • TheMoneyConverter
  • Vircurex
  • Market averages
• Support for mining pools and miner hashrates
  • BitMinter
  • BTC Guild
  • CryptoPools DGC
  • CryptoTroll DOGE
  • D2 WDC
  • Econining Peercoin
  • Eligius
  • Eobot
  • GHash.io
  • Give Me Coins
  • HashFaster DOGE
  • HashFaster LTC
  • Hash-to-Coins
  • nvc.khore.org
  • litecoinpool.org
  • LiteGuardian
  • Multipool
  • NiceHash
  • OzCoin BTC
  • OzCoin LTC
  • Slush's pool
  • TripleMining
  • WeMineLTC
  • WestHash
  • ypool.net
• Support for securities exchanges
  • 796 Xchange
  • Crypto-Trade
  • Cryptostocks
  • Havelock Investments
  • Litecoininvest
• User-defined reports page with configurable graphs and level of detail
• User-defined notifications on exchanges, balances and hashrates
• Plenty of helpful tools
  • Historical data for exchanges
  • External API status page
  • Cryptocurrency calculator widget, e.g.: https://cryptfolio.com/calculator
  • Comprehensive administrator interface
• Premium accounts to support site hosting and access more frequently updated data and advanced reports

More information: http://openclerk.org

Extending

If you want to have an openclerk base (like CryptFolio), you can place your changes into a new config/ directory, and the build script (and eventually config scripts and template scripts) will include these files as necessary. Files supported:

config/site/css/*.scss -> site/styles/*.css
config/site/img/config/* -> site/img/config/*
config/site/img/favicon.ico -> site/favicon.ico
config/templates/*.php -> site/templates/*.php