- Overview
- Technology Stack
- API Endpoints
- Deployment
- Project Structure
- Contributing
- Acknowledgments
- Contact
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.
Component | Technologies |
---|---|
jira-report-ai-api |
Python, Poetry, Nvidia NIM API |
jira-report-api |
Node.js, TypeScript |
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. |
Endpoint | Method | Description |
---|---|---|
/api/health |
GET |
Check API health status and timestamp. |
/api/info |
GET |
Fetch API metadata (name and version). |
- 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.
- 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.
- Review our contributing guidelines.
- Ensure Dependencies are Up-to-Date:
jira-report-ai-api/
: Runpoetry update
.jira-report-api/
: Runnpm install
.
- Open a GitHub Issue for questions, feature requests, or to report issues.
- Nvidia NIM API: For enabling AI capabilities.
- Jira: For providing the platform powering our report generation.
- Developer: https://nikunj.tech/
- GitHub Issues: For all project-related inquiries.