kgrewal2 / app-mathx

MathX

Project to help youngsters learning to form valid mathematical expressions.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and test system.

Prerequisites

You will need to install OpenJDK 11 and OpenJavaFX 11 in order to run the software. You will need to add firebase jar files to your library

OpenJavaFX 11

• Download OpenJavaFX 11 from Gluon Official Website.
• Extract the download file in your system and remember the location.

OpenJDK

• Linux sudo apt install openjdk-11-jdk

IntelliJ (Required you want to compile, run and generate executable)

• Install IntelliJ

Running in IntelliJ

A step by step series of examples that tell you how to get a development env running

• Clone the project

git clone https://github.com/SER515-Fall2019-Team4/app-mathx.git

• Open the project in IntelliJ

• Go to File → Project Structure

  • ↘Project

    • Set Project SDK to 11
    • Set Project level language to 11
    • Specify Project compiler output to location where you want to compile the software

  • ↘Libraries

    • Add new library + → Java

    • Go to the file location where you extracted the OpenJavaFX and add

      ../javafx/lib

  • Apply

    Adding Firebase libraries

• Download the firebase-client-android-2.5.2.jar from attachment section location: https://tree.taiga.io/project/sheran-12-ser515-classscrum/wiki/firebase-docs

• Go to File → Project Structure

  • ↘Libraries

    • Add new library + → Java
    • Go to the file location where you extracted the Firebase jar file and add the same

  • Click on Apply

Adding Firestore libraries

• Go to File → Project Structure

  • ↘Libraries

    • Add new library + → Java
    • Go to home/ of the project and add the libs folder

  • Click on Apply

• Go to Run → Edit Configuration

  • ↘ + Add new configuration → Application

    • Change Name as you like. This will be your configuration name.
    • Set Main Class as main.MainClass
    • Set vm-options as --module-path /path/to/javafx/lib --add-modules javafx.controls,javafx.fxml,javafx.web

    Replace /path/to/javafx/lib* with the path where you extracted the OpenJavaFX

  • Apply

• Go to Run → Run 'ConfigurationName'

Generating and running JAR file in IntelliJ

Generating JAR File

• Go to File → Project Structure
  • ↘ Artifacts
    • + Add new artifact → JAR → From modules with dependencies
    • Specify Main Class as main.MainClass
    • OK
  • Specify output directory
  • OK
• Go to Build → Build Artifacts → app-mathx → Build

Running JAR File

• Open terminal
• Go to output directory specified when adding new artifact

cd app-mathx/out/artifacts/app_mathx_jar/

• Run the file (replace /path/to/javafx/lib with the path to JavaFX/lib )

java -jar --module-path /path/to/javafx/lib --add-modules javafx.controls,javafx.fxml app-mathx.jar

You may refer to another README file at https://github.com/SER515-Fall2019-Team4/app-mathx/tree/master/home/main/src/controllers for more information about the project structure

Authors

• Karandeep Singh Grewal
• Aditya Bajaj
• Ria Mehta
• Manas Mahapatra
• Sheran Dass

Acknowledgments

• Michael Findler

Special Thanks to Mariusz Gromada for MathParser (Used to evaluate expressions)