Getting started with kindling

Overview

This is the core publishing code for the HL7 FHIR specification itself. The jar produced from this repository is used to take the spreadsheet data in that HL7/fhir specification and generate a fully publishable web page containing all necessary URLs and their content for the HL7 FHIR specification.

Repository

https://github.com/HL7/kindling

Prerequisites

Java

Ensure you have at minimum, the Java 11 JDK installed on your system, and your JAVA_HOME environment variable pointed to the Java SDK. If you do not have the Java JDK installed, please follow the instructions here.

Git

You should clone the project locally using git.

git clone https://github.com/HL7/kindling.git

You will need a Git CLI or a Git Client installed. A general introduction to Git can be found here

IntelliJ Users

  1. Ensure you have the latest version of Intellij IDEA Community Edition installed. Check the current version on their downloads page.
  2. This project uses lombok annotations to help reduce lines of code in some of the larger classes. You will need to install the lombok plugin. Follow the instructions here.
  3. Follow these steps to import the cloned project:
    • From the main menu, select File -> Open...
    • In the browser dialog pick the kindling directory (the root of the project)
    • If prompted whether to Trust and Open Project 'kindling' select Trust Project
    • Select which window you would like to open the project in.

When the project first loads, it will attempt an initial build, and may take several minutes to complete. Once complete, the project should allow the building and running of tests in IntelliJ. To verify, in the Gradle side panel, right click on kindling -> Tasks -> build -> build and double click to initiate another build.

Apache NetBeans Users

  1. Follow the steps in the Intellij Users section above.

Eclipse Users

  1. Ensure you have the latest version of Eclipse installed. Check the current version on their downloads page.
  2. This project uses lombok annotations to help reduce lines of code in some of the larger classes. This plugin needs to be manually added to Eclipse. Please follow the instructions on their website to set this up.
  3. Run eclipse and select your Eclipse workspace.
  4. Follow these steps to import the cloned project:
    • From the main menu, select File -> Import...
    • Select Gradle -> Existing Gradle Project
    • Click Next
    • Under Project Root Directory, pick the kindling directory (the root of the project)
    • Leave all settings as default when prompted. Eclipse should automatically elect to use the gradle wrapper, which will provide the easiest development experience.
    • Click Finish

This should import the project, and you should be able to build and run of test in the Eclipse IDE. To verify, in the Project drop-down menu, select Clean.... In the Clean window, select the kindling project. Press Clean to run a full build.

Updated: