Skip to content

User Documentation

Jump to bottom
Sai Varun Varanasi edited this page Jul 13, 2021 · 21 revisions

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 the 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

  • In your Visual Studio Installer make sure to install the following packages:

  • 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.

  • Please make also sure, that your NuGet Package settings reflect the following state:

**2.2.2 Running Frontend Code **

  • Import the code into the visual studio code.

  • Open a new terminal

  • run the following commands.
cd frontend

yarn

yarn start

This should build the code and open the project in the browser as shown below.

Access the application with the below URL:

http://127.0.0.1:3000/

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

3 Workflow

3.1 LogIn and LogOut

  • Enter the registered Username and Password to log in to the application.

  • Click on 'Forget Password' to receive a link to reset the password.

At this point in time 'User Login Management' is not implemented. (Work in progress)

  • Once the user clicks on login. The User is redirected to the "My Dashboard" page.

  • Click on 'Logout' from the Sidebar to log out the user.

3.2 Choose the required Product/Solution/Service from the required category.

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

3.3 Visualization of Impact data

  • When a product is chosen by default the calculation results of the baseline scenario of the product will be loaded on the details page. The different scenarios of the chosen product can be compared using the dropdown in the details page. Once the results are received from the backend the data will be displayed on the details page.

(Since there is no calculation data for the baseline scenario. The details page in the below screenshot does not display any data.)

(The details page for another product.)

*Click on "Export" to export the calculation result as a .docx file.

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

(Since there is no calculation data for the baseline scenario. The details page in the below screenshot does not display any data.)

4 Known Error Data Base

S.No Error Reason Work around
1 API call returns an error with status 400 There are no preset calculation settings for the project in SimaPro API. Contact System administrator to add the data in the SimaPro Application.
2 API call returns an error with status 502 Multiple API calls were made to the API before the calculation data for the previous call was returned. Restart both frontend and backend.
3 APi call returns an error with status 401 User credentials are given in the backend User Secrets not correct Please verify the credentials at the backend.
Clone this wiki locally