Ephigenia/franklin

# README

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Ephigenia/franklin/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
[![Dependency Status](https://www.versioneye.com/user/projects/5432d8c284981f50720000a5/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5432d8c284981f50720000a5)
<img src="https://scrutinizer-ci.com/g/Ephigenia/franklin/badges/quality-score.png?s=28d253b058abc7f0c31f0b2204549c09c16f4fa8" />
[![CircleCI Build Status](https://circleci.com/gh/Ephigenia/franklin/tree/master.png?circle-token=24e1bc42eaed3d81beb444519263dbcf3ddb0e88)](https://circleci.com/gh/Ephigenia/franklin/tree/master "Build Status of master")
[![Code Climate](https://codeclimate.com/github/Ephigenia/franklin/badges/gpa.svg)](https://codeclimate.com/github/Ephigenia/franklin)
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/Ephigenia/franklin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

franklin is a library for storing and displaying various metrics aquired through different apis, web-services or scraped contents. Check the [franklin demo page](http://franklin2.marceleichner.de/) for a first impression.

One important ambition for franklin is that all access is made through public available content. No use of any API keys or tokens which makes it easier to setup.

# List of available tests

Checkout the wiki for a complete list of the 35+ tests that can be displayed using franklin: [franklin wiki](https://github.com/Ephigenia/franklin/wiki)

# Running the Tests

    composer install
    vendor/bin/phpunit

# Running specific groups of tests

    vendor/bin/phpunit --group=Flipboard 

# BEWARE!

This Version of franklin is currently in development and should only be used if you’re experienced with the previous version or programming.

# Rewrite

There will be a rewrite of the whole franklin architecture in node.js in 2014. If you want to help me and help to build the next standard open source solution for tracking kpis for everyone please contact me. You can find contact infos on my [github page](https://github.com/Ephigenia)