Home

Welcome to the ReadabilityMetrics wiki!

What is it?

ReadabilityMetrics is a Web Service to Manage Texts and their Readability Scores. It was devised so it could be used from Mashape.com, as well as a standalone form.

Getting Started

First, clone this repository:

$ git clone git://github.com/ipeirotis/ReadabilityMetrics.git readability-metrics
$ cd readability-metrics

From pom.xml, edit gae.home to remove the gae.home property.

Then, read Setup Instructions and proceed as well.

Running / Importing

Run mvn clean test:

$ mvn clean test

It will run the basic unit tests. Lets run the integration tests as well:

$ mvn clean verify

If everything passes, it makes a good idea to import into your IDE.

Running Locally

You can also run the client.html test page locally:

$ mvn install
$ cd readability-metrics-webapp
$ mvn gae:run

Once running, you can open http://localhost:8080/readability/client.html

Understanding the API

The following pages describe the API:

• REST API: Diagnostics
• REST API: Managing Texts
• REST API: Retrieving Text Metrics

When in doubt, please read the source of the Integration Tests (which are triggered when you do mvn verify). They are the *IT classes under src/test/java.

Deploying into GAE:

First, review readability-metrics-webapp/src/main/webapp/WEB-INF/appengine-web.xml and see if the application name matches one where you do have deployment rights.

Then, from your top-level project:

$ mvn install

then

$ cd readability-metrics-webapp
$ mvn gae:deploy

Using the Mashape API

Please see Using Mashape in order to understand how to publish and consume from there.