Installing and configuring staticSearch

ebeshero commented 2 years ago

All operating systems

Whether you are running Mac or Windows, we need the following:

Download or clone staticSearch on your computer. Putting it with your GitHub files makes sense.
Java JDK (for developers) Check if you have Java using your shell: commands
- java --version (should show you version number and date)
- Do you want to update it? Look for the Java Control Panel (Windows or Mac)
- If you don't have it, download the latest version here: https://www.oracle.com/java/technologies/downloads/
Apache Ant: https://ant.apache.org/ Download the latest binary version, extract it, and save it somewhere easy for you to find on your computer, maybe at your users' home. (When you download, also download the PGP file, and follow the instructions at the bottom of the page to verify the release: it's important to do that to verify that it's a good download file signed by an Apache software developer.)
- Make sure when you unzip your downloaded ant, that it contains a bin/ directory.
Ant Contrib (saved into the lib/ of Ant): https://ant-contrib.sourceforge.net/
- For this, you want to ignore the cpptasks that looks like the latest thing to download. It's not what we need.
- Find the latest version of ant-contrib here: https://sourceforge.net/projects/ant-contrib/files/
- Currently (2 October 2022) that happens to be this version: https://sourceforge.net/projects/ant-contrib/files/ant-contrib/1.0b3/
- Look for the file that has bin in the name and is also a zip file. Hint: it'll have a big number of downloads recorded next to it: ant-contrib-1.0b3-bin.zip
- When you've downloaded ant-contrib, look for a file with the extension .jar inside. You'll just be copying that into ant's lib/ folder so ant can use it.

Windows

Java

Installing Java for Windows 11: https://www.makeuseof.com/windows-11-install-java-jdk/

Ant

Windows people will need to choose your own location to save this on your computer. Save it "up higher" than your github repos. You'll be setting a path variable here so it's easy to reach when you need to run staticSearch.

Test that you have Java and Ant

Java path

which java
java --version

Ant version

which ant
ant --v (should tell you build.xml fails or can't be found--all is well.)

Environment variables

Setting ANT_HOME and JAVA_HOME: https://ant.apache.org/manual/install.html
Windows help with configuring the PATH: https://docs.jboss.org/jbossas/docs/Getting_Started_Guide/beta422/html/About_the_Example_Applications-Install_Ant.html

When you test the build on Windows, this configuration will fail due to mixing the way Windows reads file paths with \and the way the processing system needs to read them with /. A solution to this problem is to configure a Linux subsystem on your Windows machine to run this build process. Instructions are posted in #3 .

Mac

Installing Java is easier for you!

Java path

which java
java --version

Ant version

Apache Ant:

If you have Homebrew installed, use brew install ant
which ant
ant --v

Java

Installing Java: https://www.oracle.com/java/technologies/downloads/#jdk19-mac (look for the .dmg file: easiest to work with!)
Updating Java: https://www.java.com/en/download/help/mac_java_update.html

Test the staticSearch configuration

Test the configuration for staticSearch 7.7: Running the search build process

kzp308 commented 2 years ago

I was able to get most of the apps/docs downloaded. However, I got stuck at Apache Ant. I'm not sure where to download it from or where to download it to. I'm quite confused but I assume we can talk about it in class.

natalyamyers commented 2 years ago

I also got stuck on downloading things, I'm glad I'm not the only one! I just felt like the instructions on downloading and installing apps, even on their own pages, were so limited. I also use a .zip file application that bundles things differently (I use it for a game that utilizes mods) so that added another layer of difficulty.

arrowarchive commented 2 years ago

I am unsure if the second link for Java supports Windows 10 or Mac specifically. Should there be a link specifically for Java on Windows 10 and below?

Something that also may be good to note is that the zip files should be kept after they are extracted. Otherwise, running ant without them may cause an error on Git Bash.

tec5271 commented 2 years ago

Still struggling to download apache ant but am going to try fiddling with it over the next day or so.

newtfire / staticSearch