This guide is intended for those who wish to:
- Contribute code to Lumify
- Create their own Lumify plugins
- Create a custom build of Lumify
In order to work with Lumify as a developer, it's recommended that:
- You know Java, since the entire backend is written in Java.
- You know JavaScript, as the UI is very JavaScript heavy.
- You're familiar with common big data tools, including the Hadoop stack, Accumulo.
If that sounds like you, then continue reading to get started.
Section 1: Get the Source Code
Before you can get started, you'll need to get a copy of the Lumify source code. This section explains how to do that and a little about the source code structure.
Section 2: Understand the Architecture
Lumify has a lot of components but an easy to understand architecture. Learning a little about the core components discussed in this section will help you better understand the project.
Section 3: Install Dependencies
Lumify has a lot of dependencies, some of which are required while others are not. This section will help you decide which dependencies you need to install for the features you want.
Section 4: Learn the Build Options
Lumify uses Maven as the build system. There are a number of build options depending on what you want to run. This section will help you understand the options.
Section 5: Create an Ontology
Lumify uses OWL files to define what type of entities you can create, what properties they can have and what they can connect to.
Section 6: Set up your IDE
Debugging and developing for Lumify is easiest using an IDE. These instructions will help you get that setup.
Section 7: Getting Help
Running Lumify is a challenging, but rewarding, endeavor. Learn about your options for getting help in this section.
Section 8: Contributing
Once you've made changes that you want to share with the community, the next step is to submit those changes back via a pull request.