The YorubaName Hackathon is almost 2 weeks away. In this post, I quickly share some things you can do as a developer to prepare for the up-coming event.

Installation Guide

The YorubaName.com application consists of two separate applications. The YorubaName Website Application and the YorubaName Dashboard Application. The Website application powers the backend services for www.yorubaname.com, while the Dashboard is the application through which lexicographers manage the entries in the dictionary.

Each application runs separately, have their code base live in separate repositories and have different software requirements.

For running and working on the YorubaName website application, you need to have the following installed

JDK 1.6+ (See installation guide)
MySQL (See installation guide)
Maven (See installation guide)

For running and working on the dashboard application, you need to have the following installed

Nodejs (See installation guide)
NPM (See installation guide)
Bower (See installation guide)
Grunt (See installation guide)

Architecture Guide

There are a couple of things you can do prior to the hackathon to get some understanding of the code base and how things tack together.

This includes:

Read the Contribution Guidelines for YorubaName Codebase.

Also, make sure to check the ReadMe for the website codebase and the ReadMe for the Dashboard. These contain essential information on how to install and run the application.

Another important thing to do in preparation for the hackathon is to watch the recorded webinar on how to get started working with the YorubaName codebase. This webinar shows how to install the required software, how to clone the codebase, and how to run both the website and dashboard application and have them interact with each other. Watching this video is highly recommended.

Last but not the least, if you have any question, please feel free to come along to our Gitter dev chat room and ask. I try my best to answer whatever questions you might have.

In case you are yet to register for the Hackathon, you can do so by following the registration link. Remember, the Hackathon is happening on April 8th, 2018, at HotelsNG: No 3, Birrel Avenue, off Herbert Macaulay Way, Sabo, Yaba, Lagos. It starts at 12 noon.