aureliano / verbum-domini

API REST for providing structured data from holy bible.

Verbum Domini

Deployed application: http://verbumdomini.herokuapp.com/

Overview

---

This project is an open data RESTFul API, which provides a set of services for retrieving data about bible translations. Such API let you easily navigate through resources. The availability of those services promotes creation of applications for many platforms like Android, iOS, desktop applications or even web sites using your preferred set of development tools.

Installation

---

It is a Java web application project. You have to fulfill some requirements in order to install project artifacts.

System requirements

• Maven 2
• JDK 1.7
• Database system (relational or MongoDB)

In order to generate the artifacts use the command:

mvn clean package

Local deploy

Despite the application is built using Java 7 you need Java 8 to run it locally using embedded Jetty web container. You can use any other web container if you please. It is up to you deploy it to Apache Tomcat 7 and run it with Java 7.

The simplest way may be deploy it to the embedded Jetty runner with command:

java $JAVA_OPTS -jar verbum-domini-app/target/dependency/jetty-runner.jar --port $PORT verbum-domini-app/target/verbumdomini.war

verbum-domini's Issues

Add support to XML

Make services provide data in XML format.

Support minified query

Add support to query minified notations like "Mt 1: 1-10".

Change association between chapter and annotation

Change association between chapter and annotation. Instead of chatper 1 x n annotations, use verses n x n anntations.

Remove schema definition from Raml file

Remove data schema definition from Raml file in order to make it clearer.

Generate help module

Generate help module. It may be better use some raml help generator provided by mulesoft.

Prepare MongoDB collections

Produce code to fill MongoDB collections with data.

Create read me

Create "read me" describing how to use and configure the system.

Reading day

Add support to query about reading day:

• First reading;
• Psalms;
• Second reading;
• Gospel.

It may be necessary to create another entity to abstract that stuff.

Generate Java client library

Generate Java client library to make easier to consume API data services. Use cgraml.

Edit verses and annotations

Create use cases to edit verses and annotations. It is recommended to implement this feature after #7 .