GitHubAI: AI-Powered GitHub Automation

A production-ready Django web application that leverages AI models to automate GitHub workflows including AI-driven issue management, automated documentation generation, semantic versioning, and code documentation extraction.

Features

🤖 AI-Driven Issue Management

Automatically generates structured sub-issues (functional requirements, test plans, etc.) from parent issues
Creates AI-powered README updates by analyzing repository files
Auto-Issue Generation: Automatically analyzes repository for maintenance tasks and creates GitHub issues
- Code quality analysis
- TODO/FIXME scanning
- Documentation gap detection
- Dependency checks
- Test coverage analysis
YAML-driven templates for customizable and consistent issue generation
Full REST API and web interface for issue management

💬 AI Chat Interface

React-based Web UI for interactive AI conversations
Multi-provider support (OpenAI, XAI/Grok, Anthropic) with dynamic model selection
Team Lead Dashboard: Query repository context and get instant answers without reading documentation
Response caching to reduce API costs and improve latency
Message history with role-based styling
Accessible at /chat when running the frontend (npm run dev in frontend/)

📝 Feedback Form for Contributors

Simple form interface for submitting bug reports and feature requests
AI generates well-formatted GitHub issues with proper labels and structure
REST API endpoint: POST /api/issues/issues/create-from-feedback/
Supports context files to provide additional repository context

📚 Automated Documentation Generation

Generates changelog entries from commit messages and diffs
Extracts and documents Python code docstrings and comments
Supports both push and pull request events
Database-backed documentation tracking

🔢 Semantic Versioning

Intelligent version bumping based on commit message tags ([major], [minor], [patch])
Syncs with Git tags for consistency
Version history tracking with database persistence

📄 PRD MACHINE - Living Document Automation

AI-powered PRD management: Automatically distills and evolves PRD.md from repository signals
Multi-document sync: Keeps README.md, PRD.md, and IP.md aligned and consistent
Zero-touch mode: Optional lock to prevent human edits ("I got this, meatbag")
Conflict detection: AI-powered comparison of documentation vs actual codebase
Export to GitHub: Generate issues from MVP user stories, changelog from version diffs
Slack alerts: Real-time notifications for high-severity conflicts
Management command: python manage.py prd_machine --distill --repo owner/repo

⚡ Modern Architecture

Django 4.2+ with PostgreSQL database
Docker containerization for easy deployment
REST API with Django REST Framework
Async processing with Celery and Redis
Admin interface for all operations
API caching to reduce AI API costs
Comprehensive logging for auditing

Quick Start

Prerequisites

Docker and Docker Compose
AI API key (e.g., OpenAI, Anthropic, etc.)
GitHub personal access token

Installation

# Clone repository
git clone https://github.com/bamr87/githubai.git
cd githubai

# Setup environment
cp .env.example .env
# Edit .env and add your AI_API_KEY and GITHUB_TOKEN

# Run automated setup
chmod +x start.sh
./start.sh

# Access application
open http://localhost:8000/admin/

Manual Setup

# Build containers
./build.sh

# Start services
docker-compose up -d

# Initialize database
./init.sh

# Create superuser
docker-compose exec web python manage.py createsuperuser

Usage

Management Commands

# Create AI-generated sub-issue
docker-compose exec web python manage.py create_issue \
    --repo owner/repo \
    --parent 123

# Create README update
docker-compose exec web python manage.py create_issue \
    --repo owner/repo \
    --issue-number 456 \
    --readme-update

# Generate documentation
docker-compose exec web python manage.py generate_docs --file path/to/file.py
docker-compose exec web python manage.py generate_docs --commit HEAD

# Bump version
docker-compose exec web python manage.py bump_version
docker-compose exec web python manage.py bump_version --type minor

# Auto-generate repository maintenance issues
docker-compose exec web python manage.py auto_issue --list-chores
docker-compose exec web python manage.py auto_issue --chore-type code_quality
docker-compose exec web python manage.py auto_issue --chore-type todo_scan --files "apps/core/services/*.py"
docker-compose exec web python manage.py auto_issue --chore-type general_review --dry-run

REST API

# Health check
curl http://localhost:8000/health/

# List issues
curl http://localhost:8000/api/issues/issues/

# Create sub-issue via API
curl -X POST http://localhost:8000/api/issues/issues/create-sub-issue/ \
    -H "Content-Type: application/json" \
    -d '{
        "repo": "owner/repo",
        "parent_issue_number": 123,
        "file_refs": ["README.md"]
    }'

# Create GitHub issue from user feedback
curl -X POST http://localhost:8000/api/issues/issues/create-from-feedback/ \
    -H "Content-Type: application/json" \
    -d '{
        "feedback_type": "bug",
        "summary": "Login button not working",
        "description": "When I click the login button on the homepage, nothing happens.",
        "repo": "owner/repo",
        "context_files": ["README.md"]
    }'

# Auto-generate repository maintenance issue
curl -X POST http://localhost:8000/api/issues/issues/create-auto-issue/ \
    -H "Content-Type: application/json" \
    -d '{
        "chore_type": "code_quality",
        "repo": "bamr87/githubai",
        "context_files": ["apps/core/services/issue_service.py"],
        "auto_submit": true
    }'

# List templates
curl http://localhost:8000/api/issues/templates/

Admin Interface

Access Django admin at http://localhost:8000/admin/:

Manage issues and templates
View AI response cache and hit rates
Monitor API logs
Track version history
Review changelog entries

Project Structure

githubai/
├── apps/                       # Django applications
│   ├── core/                   # Consolidated app (models, services, views)
│   │   ├── models.py           # All domain models (AI, GitHub, Issues)
│   │   ├── services/           # Business logic (AIService, GitHubService, etc.)
│   │   ├── views.py            # REST API endpoints
│   │   └── admin.py            # Django admin with custom actions
│   ├── prd_machine/            # PRD MACHINE automation
│   │   ├── services/core.py    # PRDMachineService (distill, sync, export)
│   │   ├── models.py           # PRDState, PRDVersion, PRDConflict
│   │   └── tasks.py            # Celery tasks for GitHub webhooks
│   └── githubai/               # Django project settings
├── frontend/                   # React + Vite UI for AI chat
├── docs/                       # Project documentation
├── infra/                      # Infrastructure (Docker, nginx, scripts)
├── tests/                      # Test suite
├── manage.py                   # Django entry point
├── PRD.md                      # Product Requirements Document
├── IP.md                       # Implementation Plan
└── VERSION                     # Current version (0.5.0)

Docker Services

The application includes 6 containerized services:

web: Django application server
db: PostgreSQL database
redis: Cache and message broker
celery_worker: Background task processor
celery_beat: Scheduled task scheduler
nginx: Reverse proxy and static file server

Configuration

Key environment variables in .env:

# Django
DJANGO_SECRET_KEY=your-secret-key
DJANGO_DEBUG=True
DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1

# Database
DATABASE_URL=postgresql://user:pass@db:5432/githubai

# APIs
AI_API_KEY=your-ai-key
GITHUB_TOKEN=your-github-token

# OpenAI
AI_MODEL=gpt-4o-mini
AI_TEMPERATURE=0.2
AI_MAX_TOKENS=2500

Development

Run in Development Mode

docker-compose -f infra/docker/docker-compose.yml -f infra/docker/docker-compose.dev.yml up

Features hot-reload, debug mode, and verbose logging.

Run Tests

docker-compose -f infra/docker/docker-compose.yml exec web pytest
docker-compose -f infra/docker/docker-compose.yml exec web pytest --cov

View Logs

# All services
docker-compose -f infra/docker/docker-compose.yml logs -f

# Specific service
docker-compose -f infra/docker/docker-compose.yml logs -f web
docker-compose -f infra/docker/docker-compose.yml logs -f celery_worker

API Endpoints

Issues

GET /api/issues/issues/ - List all issues
POST /api/issues/issues/ - Create new issue
GET /api/issues/issues/{id}/ - Get issue details
POST /api/issues/issues/create-sub-issue/ - Create sub-issue
POST /api/issues/issues/create-readme-update/ - Create README update
POST /api/issues/issues/create-from-feedback/ - Create issue from user feedback
POST /api/issues/issues/create-auto-issue/ - Auto-generate maintenance issue
GET /api/issues/templates/ - List issue templates

System

GET /health/ - Health check endpoint
GET /admin/ - Django admin interface

GitHub Actions Integration

The Django management commands can be used in GitHub Actions workflows. See Development Documentation for examples.

Documentation

📚 Comprehensive Documentation

Getting Started - Quick setup guide for new users
Documentation Index - Complete documentation navigation

📖 User Guides

Auto Issue Feature - Automated repository analysis
AI Chat Interface - Using the web chat interface
AI Provider Configuration - Configure OpenAI, XAI, etc.
Troubleshooting - Common issues and solutions

🔌 API Reference

Auto Issue Endpoints - REST API for auto-issue generation
Chat Endpoint - Conversational AI API
Interactive API - Browse API when server is running

🛠️ Development

Django Implementation - Architecture and design
Testing Guide - How to test features
Contributing - How to contribute

📋 Release Notes

Changelog - All version changes
v0.3.0 Release - AI Chat Frontend
v0.2.0 Release - Auto Issue Generation

Contributing

Contributions are welcome! Please see our Contributing Guide for details on:

Development setup
Coding standards
Testing guidelines
Pull request process

Quick start:

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Add tests for new functionality
Submit a pull request

See docs/development/contributing.md for complete guidelines.

Troubleshooting

Database connection errors

docker-compose -f infra/docker/docker-compose.yml down
docker-compose -f infra/docker/docker-compose.yml up -d db
# Wait 10 seconds
docker-compose -f infra/docker/docker-compose.yml up

Reset database

docker-compose -f infra/docker/docker-compose.yml down -v
docker-compose -f infra/docker/docker-compose.yml up -d db
docker-compose -f infra/docker/docker-compose.yml exec web python manage.py migrate

View service status

docker-compose -f infra/docker/docker-compose.yml ps
curl http://localhost:8000/health/

License

MIT License

Name		Name	Last commit message	Last commit date
Latest commit History 134 Commits
.github		.github
.vscode		.vscode
apps		apps
docs		docs
frontend		frontend
infra		infra
tests		tests
.dockerignore		.dockerignore
.env.example		.env.example
.env.test		.env.test
.env.test.example		.env.test.example
.gitignore		.gitignore
IP.md		IP.md
LICENSE		LICENSE
PRD.md		PRD.md
README.md		README.md
UPGRADE_DJANGO_5.1.md		UPGRADE_DJANGO_5.1.md
VERSION		VERSION
manage.py		manage.py
pyproject.toml		pyproject.toml
pytest.ini		pytest.ini
requirements-dev.txt		requirements-dev.txt

Folders and files

Latest commit

History

Repository files navigation

GitHubAI: AI-Powered GitHub Automation

Features

🤖 AI-Driven Issue Management

💬 AI Chat Interface

📝 Feedback Form for Contributors

📚 Automated Documentation Generation

🔢 Semantic Versioning

📄 PRD MACHINE - Living Document Automation

⚡ Modern Architecture

Quick Start

Prerequisites

Installation

Manual Setup

Usage

Management Commands

REST API

Admin Interface

Project Structure

Docker Services

Configuration

Development

Run in Development Mode

Run Tests

View Logs

API Endpoints

Issues

System

GitHub Actions Integration

Documentation

📚 Comprehensive Documentation

📖 User Guides

🔌 API Reference

🛠️ Development

📋 Release Notes

Contributing

Troubleshooting

Database connection errors

Reset database

View service status

License

About

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages