Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

IdeaBot Dashboard

Dashboard for reviewing ideas published to JIRA from IdeaBot sessions.

Architecture

  • Backend: Express + TypeScript (Port 3002)
  • Frontend: React + Vite + PatternFly 6 (Port 5174)
  • Data Source: JIRA REST API (read-only)

Setup

1. Install Dependencies

npm install

2. Configure JIRA Connection

Create backend/.env:

JIRA_URL=https://your-company.atlassian.net
JIRA_API_TOKEN=your-jira-api-token
JIRA_PROJECT_KEY=IDEA
PORT=3002

Getting a JIRA API Token:

  1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
  2. Click "Create API token"
  3. Copy the token to your .env file

3. JIRA Custom Fields

All JIRA field mappings are centralized in backend/src/jira-fields-config.ts. This is the single source of truth for field IDs.

Current field mappings:

Field Name Field ID Type Status
Session ID customfield_10060 Text ✅ Configured
Checklist State customfield_10061 Text (JSON) ✅ Configured
Artifacts customfield_10062 Text (JSON) ✅ Configured
Products customfield_10868 Multi-select ✅ Configured
Strategic Priority null TBD ⏳ Not configured
Catcher Org null TBD ⏳ Not configured

To update field mappings:

  1. Find the correct field ID in JIRA:

    curl -u email:token https://your-company.atlassian.net/rest/api/3/field | \
      jq '.[] | select(.name=="Strategic Priority")'
  2. Update backend/src/jira-fields-config.ts:

    export const JIRA_FIELDS = {
      // ... other fields ...
      STRATEGIC_PRIORITY: "customfield_XXXXX",  // Replace with actual ID
      CATCHER_ORG: "customfield_YYYYY",         // Replace with actual ID
    }
  3. Restart the backend for changes to take effect

Note: Fields with null mappings will display "—" or "Not specified" in the dashboard until configured.

Development

Start Both Backend and Frontend

npm run dev

This starts:

Start Individually

# Backend only
npm run dev:backend

# Frontend only  
npm run dev:frontend

API Endpoints

GET /api/ideas

List all ideas from JIRA

Response:

{
  "ideas": [
    {
      "id": "IDEA-123",
      "ideaName": "OAuth Authentication System",
      "owner": "John Doe",
      "state": "In Review",
      "completeness": 85,
      "lastUpdated": "2026-04-30T10:30:00Z"
    }
  ]
}

GET /api/ideas/:jiraKey

Get detailed idea information

Response:

{
  "idea": {
    "id": "IDEA-123",
    "ideaName": "OAuth Authentication System",
    "description": "Implement OAuth 2.0 authentication...",
    "sessionId": "uuid-here",
    "sessionLink": "/sessions/uuid-here",
    "checklistState": [...],
    "artifacts": [...],
    "comments": [...],
    "owner": "John Doe",
    "state": "In Review",
    "completeness": 85,
    "createdAt": "2026-04-28T09:00:00Z",
    "updatedAt": "2026-04-30T10:30:00Z",
    "jiraUrl": "https://your-company.atlassian.net/browse/IDEA-123"
  }
}

Dashboard Views

List View (/)

Table showing all ideas with:

  • ID (clickable link to JIRA)
  • Idea Name (clickable link to detail view)
  • Owner
  • State (badge with color coding)
  • Completeness (progress bar)
  • Last Updated

Detail View (/ideas/:jiraKey)

Comprehensive idea details:

  • Main Content:
    • Description
    • Validation checklist (grouped by category)
    • Comments from JIRA
  • Sidebar:
    • Owner
    • State
    • IdeaBot session link
    • JIRA link
    • Artifacts (attachments + external links)

Field Mapping

Dashboard Field JIRA Field Notes
ID key Story key (e.g., IDEA-123)
Idea Name summary Standard summary field
Strategic Priority TBD (null) Mapping to be configured
Product customfield_10868 Products (multi-select)
Owner assignee.displayName or reporter.displayName Falls back to reporter if no assignee
Catcher Org TBD (null) Mapping to be configured
State status.name JIRA workflow status
Completeness Calculated from customfield_10061 % of checklist items passed
Description description Standard description
Session ID customfield_10060 Session UUID
Checklist State customfield_10061 JSON array of checklist items
Artifacts attachment + customfield_10062 JIRA attachments + external links
Comments comment Standard JIRA comments
Created/Updated created / updated Standard timestamps

Type Checking

npm run typecheck

Building for Production

npm run build

This builds both backend and frontend for deployment.

OpenShift Deployment

For deploying to OpenShift, see DEPLOYMENT.md.

Quick deploy:

# Build and deploy to OpenShift
make all

# Get application URL
make get-route

See the Deployment Guide for full instructions.

Integration with IdeaBot

When users complete an IdeaBot session and publish to JIRA:

  1. Session data is posted to JIRA as a new Story
  2. Custom fields store session ID, checklist, and artifacts
  3. Dashboard fetches from JIRA and displays
  4. Reviewers can click through to view full details
  5. Comments and state changes happen in JIRA

Future Enhancements

  • Add filtering/search on list view
  • Add pagination for large idea lists
  • Add JIRA webhook sync for real-time updates
  • Add PostgreSQL caching layer (Option 2 - Hybrid)
  • Add state transition actions (approve/reject from dashboard)
  • Add analytics view (ideas by status, completeness trends)

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages