Skip to content

Commit

Permalink
Merge pull request #280 from chetan453/improved-docs
Browse files Browse the repository at this point in the history
specify path for ZINGG_HOME
  • Loading branch information
sonalgoyal authored May 20, 2022
2 parents 79ca4f8 + 76f94ea commit 2a14a86
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions docs/settingUpZingg.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Setting Up Zingg Development Environment
The following steps will help you setup the Zingg Development Environment. While the steps remain the same across different OS, we have provided detailed instructions for Ubuntu OS.
The following steps will help you setup the Zingg Development Environment. While the steps remain the same across different OS, we have provided detailed instructions for Ubuntu OS.

**Step 1: Clone the Zingg Repository**
* Install and SetUp Git: **sudo apt install git**
Expand All @@ -8,7 +8,6 @@ The following steps will help you setup the Zingg Development Environment. While

**Step 2: Install JDK 1.8 (Java Development Kit)**
* Follow this [tutorial](https://linuxize.com/post/install-java-on-ubuntu-20-04/) to install Java8 JDK1.8 in Ubuntu.

**Step 3: Install Apache Spark - version spark-3.1.2-bin-hadoop3.2**
* Download Apache Spark - version spark-3.1.2-bin-hadoop3.2 from the [Apache Spark Official Website](https://spark.apache.org/downloads.html)
* Install Downloaded Apache Spark - version spark-3.1.2-bin-hadoop3.2 on your Ubuntu by following [this tutorial](https://computingforgeeks.com/how-to-install-apache-spark-on-ubuntu-debian/)
Expand All @@ -20,10 +19,16 @@ The following steps will help you setup the Zingg Development Environment. While
**Step 5: Set JAVA_HOME to JDK base directory**
* Go to **cd /etc** directory in your Ubuntu system, and open the **‘profile’ file** using gedit. Just run **sudo gedit profile**
* Paste these in the **‘profile’ file**
**export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64**
**export SPARK_HOME=~/spark-3.1.2-bin-hadoop3.2**
**export SPARK_MASTER=local[\*]**
**export ZINGG_HOME=/home/rightcode/zingg/assembly/target**
```
export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64
export SPARK_HOME=~/spark-3.1.2-bin-hadoop3.2
export SPARK_MASTER=local[\*]
export ZINGG_HOME=<path_to_zingg>/assembly/target
```
where <path_to_zingg> will be directory where you clone the repository of the Zingg. Similarly, if you have installed spark on different directory you can set **SPARK_HOME** accordingly.


**Note:-** If you have already setup **JAVA_HOME** and **SPARK_HOME** in the steps before you don't need to do this again.

**Step 6: Compile the Zingg Repository**
* Run the following to Compile the Zingg Repository - **mvn clean compile package -Dspark=sparkVer**
Expand All @@ -36,3 +41,4 @@ The following steps will help you setup the Zingg Development Environment. While
* Run this Script in terminal opened in zingg clones directory - **./scripts/zingg.sh --phase findTrainingData --conf examples/febrl/config.json**

**If everythings right, it should show Zingg Icon.**

0 comments on commit 2a14a86

Please sign in to comment.