Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ on:
- cron: '0 * * * *'
workflow_dispatch:

permissions:
id-token: write
contents: read
pages: write

concurrency:
group: "pages"
cancel-in-progress: false
Expand All @@ -19,11 +24,6 @@ jobs:
build-and-deploy:
runs-on: ubuntu-latest

permissions:
contents: read
pages: write
id-token: write

steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand Down Expand Up @@ -295,13 +295,16 @@ jobs:
EOF

- name: Setup GitHub Pages
if: github.event_name != 'pull_request'
uses: actions/configure-pages@v4

- name: Upload artifacts
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: 'docs'

- name: Deploy to GitHub Pages
if: github.event_name != 'pull_request'
id: deployment
uses: actions/deploy-pages@v4
42 changes: 21 additions & 21 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# PlotSenseAI Hackathon 2025 - Dashboard Documentation

## 🎯 Overview
## Overview

This GitHub Pages site serves as the official dashboard for the PlotSenseAI Hackathon 2025, providing real-time metrics, submission showcases, and comprehensive analytics for the hackathon.

## 🚀 Features
## Features

### 📊 Real-time Metrics Dashboard
### Real-time Metrics Dashboard
- **Submission Statistics**: Live count of total submissions, teams, and validation status
- **Track Distribution**: Visual breakdown of ML vs Dev track participation
- **Technology Analytics**: Most popular tech stacks and frameworks used
- **Timeline Tracking**: Submission trends and daily activity

### 🏆 Project Showcase
### Project Showcase
- **Interactive Gallery**: Browse all submitted projects with filtering by track
- **Rich Project Cards**: Display team info, tech stack, demo videos, and social links
- **Validation Status**: Real-time indication of submission validation status
- **Direct Links**: Quick access to GitHub repos and demo videos

### 📈 Analytics & Leaderboards
### Analytics & Leaderboards
- **Social Engagement**: Track social media activity and community participation
- **Innovation Metrics**: Technology diversity and creative stack usage
- **Completion Rates**: Validation success and submission quality metrics

### 🔄 Automated Updates
### Automated Updates
- **5-minute refresh cycle** for real-time data
- **GitHub Actions integration** for automatic deployment
- **Data aggregation** from submission JSON files
- **README statistics** auto-update with submission counts

## 🛠 Technical Architecture
## Technical Architecture

### Frontend Stack
- **HTML5** with semantic markup and accessibility features
Expand All @@ -56,7 +56,7 @@ Process: Data aggregation → Build → Deploy to GitHub Pages
Result: Live dashboard with latest submission data
```

## 📁 File Structure
## File Structure

```
docs/
Expand All @@ -70,7 +70,7 @@ docs/
└── metrics.json # Computed metrics and statistics
```

## 🎨 Design System
## Design System

### Color Palette
- **Primary**: #6366f1 (Indigo) - Main brand color
Expand All @@ -90,7 +90,7 @@ docs/
- **Buttons**: Gradient backgrounds with hover states
- **Status Indicators**: Color-coded with clear labels

## 🚀 Getting Started
## Getting Started

### Local Development
```bash
Expand Down Expand Up @@ -152,7 +152,7 @@ npx http-server .
}
```

## 🔧 Configuration
## Configuration

### Environment Variables
No environment variables required - the dashboard runs entirely client-side with data from JSON files.
Expand Down Expand Up @@ -180,29 +180,29 @@ const chartOptions = {
}
```

## 📱 Responsive Design
## Responsive Design

The dashboard is fully responsive with breakpoints:
- **Desktop**: 1200px+ (Full layout with sidebar charts)
- **Tablet**: 768px-1199px (Stacked layout, larger touch targets)
- **Mobile**: <768px (Single column, optimized navigation)

## Accessibility
## Accessibility

- **Semantic HTML** with proper heading hierarchy
- **ARIA labels** for interactive elements
- **Keyboard navigation** support
- **High contrast** color ratios (WCAG AA compliant)
- **Screen reader** compatibility

## 🔍 SEO Optimization
## SEO Optimization

- **Meta tags** for social media sharing
- **Structured data** for search engines
- **Performance optimization** with lazy loading
- **Progressive enhancement** for all users

## 📊 Analytics Integration
## Analytics Integration

Ready for integration with analytics platforms:
```javascript
Expand All @@ -213,14 +213,14 @@ gtag('event', 'view_submission', {
});
```

## 🛡 Security
## Security

- **No server-side code** reduces attack surface
- **Static hosting** on GitHub Pages
- **Input sanitization** for any dynamic content
- **CSP headers** recommended for production

## 🚀 Performance
## Performance

### Optimization Features
- **Lazy loading** for non-critical resources
Expand All @@ -233,7 +233,7 @@ gtag('event', 'view_submission', {
- **Largest Contentful Paint**: <2.5s
- **Cumulative Layout Shift**: <0.1

## 🤝 Contributing
## Contributing

### Adding New Features
1. **Fork** the repository
Expand All @@ -250,7 +250,7 @@ Use GitHub Issues with:
- **Expected vs actual** behavior
- **Screenshots** if applicable

## 📅 Maintenance
## Maintenance

### Regular Tasks
- **Monitor** dashboard performance
Expand All @@ -266,7 +266,7 @@ Use GitHub Issues with:
- [ ] Check load times
- [ ] Review analytics data

## 📞 Support
## Support

For technical issues or questions:
- **GitHub Issues**: [Repository Issues](https://github.com/PlotSenseAI/PlotSenseAI-Hackathon-Submissions/issues)
Expand All @@ -277,4 +277,4 @@ For technical issues or questions:

Developed by PlotSenseAI and the Havilah Academy team.

**Happy hacking!** 🚀
**Happy hacking!**