User Documentation

• 1 Introduction
  • 1.1 Scope and Purpose
• 2 Process Overview
  • 2.1 Software tools requirements
  • 2.2 Running the code
    • 2.2.1 Running Backend code
    • 2.2.2 Running Frontend Code
• 3 Workflow
  • 3.1 Choosing products from categories
  • 3.2 Comparing models of a product

1 Introduction

1.1 Scope and Purpose

Carbon footprint is a research subject that is active in recent years. The goal of this project is to furnish support to our users by providing a tool for them to visualize their solutions and to help them speed up their business while meeting global challenges such as urbanization, demographic change, climate change, and resource scarcity.

This document helps to run and navigate through the application.

2 Process Overview

2.1 Software tools requirements

Frontend Tools: Visual Studio Code Node.js npm

Backend Tools: Visual Studio

2.2 Running the code

Import the project code from GitHub repository:

Source: HTTPS: https://github.com/amosproj/amos-ss2021-carbon-footprint.git

SSH: [email protected]:amosproj/amos-ss2021-carbon-footprint.git

2.2.1 Running Backend code

• Import the code into the visual studio.
• Double click on the CarbonFootPrintVisualization.sln in the backend folder to extract the backend code.

• Right-click on the backend project and click on Manage User secrets. Which opens Secrets.json add the following and save the file. { "BaseUrl": "https://apps.simapro.com/api/" "User": "[insert SimaPro User here]" "Password": "[insert SimaPro password here]" }

• Run the code on the “IIS Express” server.

2.2.2 Running Frontend Code

• Import the code into the visual studio code.

• Open new terminal

• Navigate to the frontend folder and run the following commands. npm install npm start

This should build the code and open the project in the browser as shown below. (The landing and login page is still under development. The website will redirect to the “My Dashboard” page of the project which is also under development at this point in time.)

Once both the frontend and backend codes are running all the functionalities of the website can be accessed.

3 Workflow

3.1 Choosing products from categories

• Choose the category of product from the side navigation bar. The products/Services/Solutions under the chosen category can be selected from here.

3.2 Comparing models of a product

• The different models of a specific model can be compared using the Details module. The results can be visualized and can be exported as a PDF (work under progress) from here.

• Click on “compare” to compare the emissions of the two models. Choose the two models that need to be compared from the drop-down.