Installation Guide:

Electron Application Setup:

• Install files from latest GitHub release for your OS.

• Run .exe file.

Running from repo:

Requires npm to be installed on the machine.

• Clone the “Drawio-Electron” GitHub repository.

• Run “npm i electron” in a terminal at the folder.

• Run “npm i electron-forge” in a terminal at the folder

• Run “npm start” in a terminal at the folder.

Building a new executable

This will build an executable for the OS you are currently running.

Requires npm to be installed on the machine.

• Clone the “Drawio-Electron” GitHub repository.

• Run “npm i electron” in a terminal at the folder.

• Run “npm i electron-forge” in a terminal at the folder

• Run "npm run make" in a terminal in the folder.

Excel Add-In Setup:

• Unzip provided file into its own directory e.g. C:\Users\’YourUser’\ExcelAddin

Using a Local Host:

• Install Node.JS - https://nodejs.org/en/download

• Run “npm install office-addin-debugging” in a terminal in the same directory as the unzipped folder.

• Run “npm run start” in a terminal in the same directory as the unzipped folder.

Alternatively, you can host this on your own web server.

Use:

XML Files:

• Draw a CG Graph using the embedded Draw.io (or use a pre-made one).

• Export the graph as an uncompressed XML file.

• Click the “Choose File” button and navigate to the file.

• Click the CGFCA button.

• Save the report and CXT file on the system.

CSV Files:

• Click the “Choose File” button and navigate to the CSV file.

• Enter the delimiter used for the CSV in the text box that appears.

• Click the CGFCA button.

• Save the report and CXT file on the system.

Excel Add-In:

• Start the Add-In using the steps above.

• Open the desired CSV/Excel File.

• Click the “CGFCA” button and save the report and CXT files in the desired location.

Known Issues

These are known issues that don't fit into the testing plan.

• The XML parser seems to repeat input concepts. As such it breaks on larger CG Graphs.

  This is likely due to how the XML parser is detecting concepts and not an issue with translated the triples to binaries algorithm itself

• Draw.IO has an error message that randomly appears.

  Unknown what causes this and due to the implementation of Draw.IO in our program, it is difficult to track down.

• The CGIF parser is only partially finished.

  Possible to reimplement

The Program Itself

The code itself is largely a 1 to 1 refactoring of the original C++ program in Node.JS. This means that any features that were in the original work well here with no issues.

To break it down:

Features that are unchanged:

• CSV parser
• Triples-to-binaries algorithm (and adjacent functions)

Features that were changed or are new:

• XML Parser
• Saving/downloading files
• The GUI
• Embedded Draw.IO compatability

The largest improvement to the program we made was the refactored code as it allows compatability with every OS. As it is a 1 to 1 conversion, the original features all work and have no issues. It provides a good base to implement some of the new features we attempted but in a better way.

It may be best to use this base and create a Draw.IO plug-in and utilise a web-server to host it on.