Ai Jira Standup Report API

Table of Contents

1. Overview
2. Technology Stack
3. API Endpoints
4. Deployment
5. Project Structure
6. Contributing
7. Acknowledgments
8. Contact

Overview

Automate daily scrum reports from Jira data with our Ai-powered API. This project comprises two interconnected APIs:

• jira-report-ai-api: Leverages Python, Poetry, and Nvidia's NIM API for AI-driven insights.
• jira-report-api: Built with Node.js and TypeScript for a robust API gateway.

Technology Stack

Component	Technologies
jira-report-ai-api	Python, Poetry, Nvidia NIM API
jira-report-api	Node.js, TypeScript

API Endpoints

Scrum Report

Endpoint	Method	Description
/api/report/set-cron-time	POST	Update cron schedule for automated reports.
/api/report/trigger-manual	POST	Manually trigger report generation and sending.
/api(report/current-schedule	GET	Retrieve current cron schedule setup.
/api/report/recent	GET	Fetch up to 5 recent reports.
/api/report/{id}	GET	Retrieve a specific report by ID.

Health and Info

Endpoint	Method	Description
/api/health	GET	Check API health status and timestamp.
/api/info	GET	Fetch API metadata (name and version).

Deployment

• Containerization: Utilize docker-compose.yml files in the root and component directories for streamlined deployment.
• Service Configuration: Refer to each API's docker-compose.yml for specific service setups.

Project Structure

• Detailed Overview: Available in project_structure.txt.
• Key Directories:
  • jira_report_ai_api/: Python-based AI API.
  • jira_report_api/: Node.js-based API gateway.
  • tests/: Unit and integration tests for both APIs.

Contributing

1. Review our contributing guidelines.
2. Ensure Dependencies are Up-to-Date:
   • jira-report-ai-api/: Run poetry update.
   • jira-report-api/: Run npm install.
3. Open a GitHub Issue for questions, feature requests, or to report issues.

Acknowledgments

• Nvidia NIM API: For enabling AI capabilities.
• Jira: For providing the platform powering our report generation.

Contact

• Developer: https://nikunj.tech/
• GitHub Issues: For all project-related inquiries.