Feat: Hackathon Django Plugin #5

mdkaifansari04 · 2025-11-26T18:14:12Z

Fixes: #4

Quick Testing Guide for BLT Hackathon Plugin

Test video

2025-11-27.00-00-16_compressed.mp4

This guide will help you quickly test the Django Hackathon plugin in under 5 minutes.

Prerequisites

Python 3.11+
Django knowledge (basic)

Step 1: Create a Test Django Project

# Create a new directory for testing
mkdir hackathon-test && cd hackathon-test

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install Django
pip install django

# Create Django project
django-admin startproject testproject
cd testproject

Step 2: Install the Hackathon Plugin

# Install from TestPyPI
pip install -i https://test.pypi.org/simple/ blt-hackathon==0.1.1

Latest Version: Check https://test.pypi.org/project/blt-hackathon for the newest version.

Step 3: Configure Django Settings

Edit testproject/settings.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    
    # Add the hackathon plugin
    'blt_hackathon',
]

Step 4: Configure URLs

Edit testproject/urls.py:

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('hackathons/', include('blt_hackathon.urls')),
]

Step 5: Create Base Template (Required for Charts)

Create directory and file: testproject/templates/base.html

mkdir templates

Create templates/base.html:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{% block title %}Hackathon Test{% endblock %}</title>
    
    <!-- Required: Chart.js for charts -->
    <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
    
    <!-- Required: Font Awesome for icons -->
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" 
          integrity="sha512-DTOQO9RWCH3ppGqcWaEA1BIZOC6xxalwEsw9c2QQeAIftl+Vegovlnee1c9QX4TctnWMn13TZye+giMm8e2LwA==" 
          crossorigin="anonymous" referrerpolicy="no-referrer" />
    
    <!-- Optional: Basic styling -->
    <script src="https://cdn.tailwindcss.com"></script>
    
    {% block extra_head %}{% endblock %}
</head>
<body class="bg-gray-100">
    <div class="container mx-auto py-8">
        {% block content %}{% endblock %}
    </div>
    
    <!-- Required: Scripts block for Chart.js initialization -->
    {% block scripts %}{% endblock %}
</body>
</html>

Update testproject/settings.py to include templates directory:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],  # Add this line
        'APP_DIRS': True,
        'OPTIONS': {
            # ... rest of the config
        },
    },
]

Step 6: Run Migrations and Create Superuser

# Apply migrations
python manage.py migrate

# Create superuser for admin access
python manage.py createsuperuser
# Enter: username=admin, [email protected], password=admin123

Step 7: Start Server and Test

# Start development server
python manage.py runserver

Step 8: Access and Test Features

Quick Test Checklist:

Visit Hackathon List: http://127.0.0.1:8000/hackathons/
- Should show empty list with "Create Hackathon" button
Create Test Hackathon:
- Click "Create Hackathon"
- Fill in:
  - Name: "Test Hackathon 2024"
  - Description: "A test hackathon for plugin testing"
  - Start Date: Today's date
  - End Date: Tomorrow's date
- Click "Create"
Test Detail Page:
- Click on your created hackathon
- ** Charts should display**: You should see:
  - Pull Request Activity chart (bar chart)
  - Page Views sparkline (small chart)
- ** Icons should display**: Font Awesome icons should be visible
Test Admin Interface: http://127.0.0.1:8000/admin/
- Login with superuser credentials
- Navigate to "BLT_HACKATHON" → "Hackathons"
- Should see your created hackathon

Success Indicators

Charts render properly (no console errors)
Font Awesome icons display
Responsive design works
Admin interface accessible
CRUD operations work (Create, Read, Update, Delete hackathons)

Troubleshooting

Charts Not Displaying?

Check browser console for JavaScript errors
Ensure Chart.js is loaded: <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
Ensure base template has {% block scripts %}{% endblock %}

Icons Not Displaying?

Check network tab for Font Awesome CSS load errors
Ensure Font Awesome CSS is in <head> section

500 Server Errors?

Check Django debug output
Ensure all migrations are applied: python manage.py migrate
Ensure blt_hackathon is in INSTALLED_APPS

Next Steps

Add GitHub repositories to track real pull requests
Configure sponsors and prizes
Customize the styling to match your project
Deploy to production

Total setup time: ~5 minutes

…and base HTML template

…ory handling and data refresh

…templates - Created initial plugin structure with __init__.py - Implemented Hackathon, HackathonPrize, and HackathonSponsor models - Developed forms for Hackathon, HackathonSponsor, and HackathonPrize - Added views for listing, creating, and updating hackathons - Implemented repository management features including refreshing data from GitHub - Created base HTML template for consistent layout - Defined URL patterns for hackathon-related views

… level, add app

…orms and models

… pyproject.toml

…thon and GitHubIssue models

… management

… data handling

…ibuting guidelines.

… tag instead of inline template generation.

…ackathon views

… with Bootstrap and Font Awesome

…ies for Chart.js and Font Awesome

Pritz395

Very Minor issues but can cause crash:

1 The GitHubIssue model has no state field
2 Wrong field name (views.py line 781), using url= but model expects github_url=
3 Missing contributor relationship (views.py line 748), the Repository has no contributor field
4 Admin references non-existent fields (admin.py lines 42-55) , fieldsets include theme, location, is_online, etc. that don't exist in Hackathon model
5 Not a blocker but too many debug prints all over the repo, could probably fix this

mdkaifansari04 added 28 commits November 25, 2025 23:49

Add initial files for Hackathon Plugin including .gitignore, README, …

a1fd764

…and base HTML template

feta: Add hackathon model and URL routing for management views

78c26b7

feat: add forms and views for hackathon management, including reposit…

441d9d2

…ory handling and data refresh

feat: add pyproject.toml

cde2ce0

feat: add hackathon template

b9cad29

(feat+refactor): remove the organization model and use it from parent…

11bf07c

… level, add app

feat: add django admin

4789447

feat: implement dynamic organization or owner handling in hackathon f…

edb1f3f

…orms and models

chore: update gitignore

3d89166

feat: add manifest file

8769a36

refactor: updated the module name

60dfe39

refactor: updated the module name

b18df0a

fix: correct urlpatterns variable name and update package includes in…

4628ee6

… pyproject.toml

feat: add initial migration and update admin configurations for Hacka…

9d5bb53

…thon and GitHubIssue models

feat: implement context processors and update templates for hackathon…

8a5a454

… management

feat: enhance form templates and views for better user experience and…

1c866ea

… data handling

feat: add custom and icon CSS, update Font Awesome, and include contr…

ca32ab0

…ibuting guidelines.

docs: add contribution guidelines and enhance README

ac22806

refactor: initialize window.selectedRepositories from a JSON script…

1992b02

… tag instead of inline template generation.

chore: add fontawesome kit

f78e2a4

refactor: remove repository contraint from model

a636352

fix: runtime erorr

63c3293

refactor: enhance permission checks and add debugging statements in H…

7f50348

…ackathon views

feat: add vendor fontawesome and bootstrap static files

3f74728

feat: update templates to use hackathon_base.html and enhance styling…

f7556b6

… with Bootstrap and Font Awesome

feat: update README and detail template to include frontend dependenc…

79201f1

…ies for Chart.js and Font Awesome

(chore: refactor): update readme and add testing.md

d139186

Pritz395 suggested changes Nov 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feat: Hackathon Django Plugin #5

Feat: Hackathon Django Plugin #5

Uh oh!

mdkaifansari04 commented Nov 26, 2025 •

edited

Loading

Uh oh!

Pritz395 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Feat: Hackathon Django Plugin #5

Are you sure you want to change the base?

Feat: Hackathon Django Plugin #5

Uh oh!

Conversation

mdkaifansari04 commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Quick Testing Guide for BLT Hackathon Plugin

Test video

Prerequisites

Step 1: Create a Test Django Project

Step 2: Install the Hackathon Plugin

Step 3: Configure Django Settings

Step 4: Configure URLs

Step 5: Create Base Template (Required for Charts)

Step 6: Run Migrations and Create Superuser

Step 7: Start Server and Test

Step 8: Access and Test Features

Quick Test Checklist:

Success Indicators

Troubleshooting

Charts Not Displaying?

Icons Not Displaying?

500 Server Errors?

Next Steps

Uh oh!

Pritz395 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mdkaifansari04 commented Nov 26, 2025 •

edited

Loading