CGC Data Visualization Tool

• Application and Features 📊
• Application Usage 🌐
• Accepted File Formats 📁
• Installation🛠️
  • Automatic Install 🤖
    • Linux and macOS 🐧 🍎
  • Manual Install 🖥️
    • Linux, macOS and Windows 🐧 🍎 🪟

Application and Features 📊

The CGC-DataVizTool is a web-based program that simplifies and aids in displaying agricultural data and mapping for the Canadian Grain Commission 🍁

• Works to convert complicated agricultural data sets into intuitive, interactive, and informative visual representations with custom filters courtesy of CGC.
• Remains an open source project, allowing for easy customization and expansion.
• Focus on agricultural geographic data analysis.

Application Usage 🌐

Please refer to the ? button in the application for detailed instructions on how to use the application.

Close the terminal to stop the application.

Accepted File Formats 📁

• CSV (Comma Separated Values)

Installation🛠️

Automatic Install 🤖

Linux and macOS 🐧 🍎

• Download the auto-init.tar.gz file from the release section.
• Extract the files.
• Run the auto-init.sh script with the following command:

./auto-init.sh

The script will ask and wait input for:

• PORTS
• Max Data Retention Time (in minutes) - Defines how long the server will retain the session data before auto delete e.g file uploads
• Start the server automatically (y/n)

The script will automatically install the required packages, build the product, and ask (y/n) to start the server.

Manual Install 🖥️

Linux, macOS and Windows 🐧 🍎 🪟

• Clone the repository:

git clone git@github.com:ishraqn/CGC-DataVizTool.git

or

Download the zip file under the Code tab.

• Install Node.js

• Configure the environment variables

- Copy the .env.template file and rename it to .env
- Fill the required fields as per the instructions within the .env file

• Install the required packages (from the root directory)

npm run init

• Build the product (from the root directory)

npm run build

• Start the server (from the root directory)

npm run start