Yorubaname/the-yoruba-dictionary

Source code for the Yoruba dictionary ## The Yoruba Dictionary web application The Yoruba Dictionary web application powers the backend services for www.yorubaword.com. It includes various modules that implement the various needed functionality. The code for the front-facing website found at www.yorubaword.com is also included in it. ## Getting Started With Running and Development This should be your 5-minute guide to getting the application running on your local machine and contributing code. ### Requirement You need to have the following installed: 1. JDK 1.6+ 2. MySQL (you do not need to install MySQL if running in in-memory mode. Continue reading to learn how to start the application with in memory database) 3. Maven Consult this link for more information on how to install the JDK. Consult this link for more information on how to install Maven. ### Overview First a quick overview of how things stack up should be of help. The Yoruba Dictionary web application is the backend portion of the Yoruba dictionary, and it is built around individual modules that perform one functionality and that functionality only. For example we have `elastic-search` module for the search etc. The `webapi-module` is built using these other modules and its own functionality is to expose the services the dictionary application offers over a REST API. The `website module` is the front facing part of the dictionary. It is also built using the APIs exposed by the `webapi-module` The idea behind this set up is to be able to deploy the `webapi-module` and build services on its API the way the Yoruba Dictionary dashboard dashboard app does. A mobile tier would also take advantage of this setup or to have the `webapi-module` as a coupled dependency to another software component (The way the `website` component depends on `webapi-module`.) Now with the general overview out of the way, let us look at getting the application running on your local machine. ### Running the Website Application There are two ways in which …