Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following instructions help to set up the development environment for STEP on a Mac.

...

Installation

(You probably want to create a project folder. The following assumes this is /dev)

Your Mac need the brew command.  If it is not installed, review the instruction on this page.

Install Java

Install Java JDK (Java 8 is required, but there may be problems with 9 and upwards)

For Mac with M1 processor, I followed instruction similar to this page.  I have the "Zulu 8.66.0.15-CA-macos-aarch64" installed on my Mac.

Configure paths and environment variables

  • This is in my .zshrc file:
    • export JAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre

Install Maven

brew install maven

Install Git

Install git If it is not already installed

Install Tomcat

Install Apache Tomcat.  On Mac, if you use homebrew run:  brew install tomcat@9

...

       org.apache.catalina.webresources.Cache.level = SEVERE

Install stand-alone version of STEP

Install the download version of STEP from http://www.stepbible.org/downloads.jsp.  Installing the stand-alone version of STEP will install a few Bible modules (ESV, SBLG, OHB, ...) which is required to run STEP.  If you do not install the stand-alone version of STEP, you will not have any Bible modules and the development environment will not start.

Clone your fork of the source code

For example:

  • Fork JSword into your Github account (from tyndale/jsword - unless already done above)

  • Clone JSword on your computer

...

We are not using the master branch for JSword. So you will need to switch branch once it is cloned:

cd jsword
git checkout jsword-stepbible-2022
  • Clone STEP

cd /dev (use the appropriate directory on your system)
git clone https://github.com/stepbible/step.git 

Build the code

Run the following commands from a git command prompt:

...

cd /dev/step
mvn clean install -DskipTests=true

Install Intellij

  • Download the Intellij Community Edition from here: http://www.jetbrains.com/idea/download/.  The Community Edition is free and seems to have all the Java development functions.  The Community Edition cannot debug jsp files but we rarely change our jsp files.   
  • Import JSword as a Maven project
    • File>New>"Project from Existing sources":
    • Find, select and open the jsword folder (eg /dev/jsword)
    • Select "Import project from external model", select "Maven", click "Create" button
    • Select (check) the "Import Maven projects automatically" option.  (Not sure if this shows up on the Mac.  This showed on Windows in a previous version of IntelliJ)

...