JI-RADAR: Sustainability Tool Support for Requirements Engineering

JI-RADAR is an Atlassian Jira Forge application designed to systematically capture, assess, and trace sustainability-related impacts directly within the agile Requirements Engineering (RE) process.

By integrating the Sustainability Management Model (SuMM) into standard Jira workflows, this tool bridges the gap between abstract regulatory reporting requirements and day-to-day software development, without forcing stakeholders to abandon established project management platforms.

✨ Key Features

• SuMM Configuration: Tailor sustainability dimensions (Environment, Social, Technical, Economic, Individual) and their weights on a per-project basis.
• Contextual Issue Assessments: Capture and evaluate sustainability impacts directly within the Jira issue view using an interactive assessment wizard.
• Sustainability Dashboard: Generate sprint-level and product-level KPI reports, visualize data through heatmaps and trend graphs, and export results for external auditing.

🛠 Prerequisites

For Users

1. Open a browser
2. (Create Atlassian account)
3. Log in to the Atlassian account with administrator privileges to the Jira target instance.
4. Open the install link and click on "Get app".
5. Then follow the installation dialog until the app is installed.
6. Done!

For Developers

To build the app from source:

• The Forge CLI installed and an Atlassian account with permissions to deploy apps.
• Node.js (LTS version; ensure it matches the runtime specified in manifest.yml).

🚀 Build and Deploy

Most of the application code resides in the SustainScrum-Plugin/ directory. To deploy the app to your Jira instance, run the following commands:

cd SustainScrum-Plugin

# Install backend dependencies
npm install

# Build the React Custom UI
cd custom-ui 
npm install 
npm run build 
cd ..

# Deploy to Atlassian Cloud
forge deploy

Note: The custom-ui folder contains the React frontend (admin pages, issue panels, dashboards). The Forge resolver runs from src/. Check the nested README.md files in these directories for deeper technical details.

📂 Repository layout

Path	Description
SustainScrum-Plugin/src/	Forge Resolver containing invoke handlers, Forge storage interactions, and Jira REST API integrations via asUser().
SustainScrum-Plugin/custom-ui/	Source code for the Custom UI. Running npm run build generates the build-* directories referenced in the manifest.
SustainScrum-Plugin/manifest.yml	Defines Forge modules (admin page, project page, issue panel, global page, issue action) and OAuth scopes.

📖 How to Use JI-RADAR

1. Installation: Deploy the app via Forge or install it via the provided distribution link to your Jira Cloud site.
2. Setup the SuMM: Navigate to the JI-RADAR Admin Area (or global app page) to configure the Sustainability Management Model for your project. Define the relevant dimensions, assign weights, and customize the assessment questions.
3. Assess Artifacts: Open any Jira issue (e.g., User Story, Task) and locate the Sustainability Assessment panel to execute the assessment wizard.
4. Reporting & Insights: Open the Sustainability Dashboard (available globally or as a project tab) to view aggregated metrics, filter by sprint, and export the generated KPI reports.

(Missing configurations or API errors will be surfaced dynamically within the UI.)

📝 License & Third-Party Software

Package metadata and licenses are located in the respective package.json files. Atlassian Forge platform packages and dependencies are subject to their respective Atlassian terms of service.