Skip to content

ScienceArtist/reportcard.fun

Repository files navigation

🎯 What This Is

This repository serves as a centralized database for all civic issue reports from reportcard.fun. Instead of expensive backend infrastructure, we use GitHub Issues as a free database with automated analytics processing.

πŸš€ Features

  • πŸ“Š Unlimited Storage - Store millions of civic reports for free
  • πŸ€– Automated Analytics - GitHub Actions process data every 6 hours
  • πŸ“ˆ Real-time Dashboard - Live statistics and insights
  • 🏷️ Smart Categorization - Automatic labeling by issue type and location
  • πŸ” Search & Filter - Built-in GitHub search capabilities
  • πŸ“± Community Insights - Track trends and hotspots
  • πŸ’° Zero Cost - Completely free forever!

πŸ—οΈ How It Works

Data Flow

User generates certificate β†’ GitHub Issues API β†’ Issue created β†’ Analytics processed β†’ Dashboard updated

Storage Structure

Each civic report becomes a GitHub issue with:

  • Title: Issue type + location
  • Body: Structured data (type, location, date, notes, etc.)
  • Labels: Categorization (issue-type, location, year, etc.)
  • State: Open (active) or Closed (resolved)

πŸ“Š Analytics Dashboard

The system automatically generates:

  • Total reports count
  • Issue type distribution
  • Geographic hotspots
  • User activity tracking
  • Daily activity trends
  • Top contributors

πŸ› οΈ Technical Stack

  • Database: GitHub Issues (unlimited, free)
  • Automation: GitHub Actions (2,000 free minutes/month)
  • Processing: Node.js scripts
  • Analytics: JSON data files
  • Frontend: React dashboard component

πŸš€ Getting Started

For Users

  1. Visit reportcard.fun
  2. Report a civic issue (pothole, garbage, etc.)
  3. Generate certificate with photo and location
  4. Your report is automatically stored in this database
  5. View community analytics and insights

For Developers

  1. Clone this repository
  2. Install dependencies: npm install
  3. Run analytics: npm run analytics
  4. View generated data in analytics/ folder

πŸ“ Repository Structure

civic-issues-database/
β”œβ”€β”€ .github/
β”‚   └── workflows/
β”‚       └── analytics.yml          # Automated analytics
β”œβ”€β”€ scripts/
β”‚   β”œβ”€β”€ analytics.js               # Data processing
β”‚   β”œβ”€β”€ create-summary.js          # Summary generation
β”‚   └── comment-analytics.js       # Issue comments
β”œβ”€β”€ analytics/                     # Generated analytics files
β”‚   β”œβ”€β”€ summary.json
β”‚   β”œβ”€β”€ issue-types.json
β”‚   β”œβ”€β”€ locations.json
β”‚   └── daily-activity.json
β”œβ”€β”€ package.json                   # Dependencies
└── README.md                      # This file

πŸ”§ Automation

GitHub Actions Workflow

  • Triggers: Every 6 hours, on issue events
  • Processes: All civic reports
  • Generates: Analytics and summaries
  • Updates: Dashboard data automatically

Analytics Generation

  • Frequency: Every 6 hours
  • Data: All issues in repository
  • Output: JSON files + Markdown summary
  • Storage: Committed to repository

πŸ“ˆ Scaling

Current Limits

  • GitHub Issues: Unlimited
  • GitHub Actions: 2,000 minutes/month (free)
  • Repository size: 1GB (sufficient for metadata)
  • API rate limits: 5,000 requests/hour

Future Scaling

  • Multiple repositories for different regions
  • Advanced analytics with external tools
  • Real-time processing with webhooks
  • Machine learning insights

🀝 Contributing

We welcome contributions! Here's how you can help:

  1. Report Issues: Use GitHub Issues for bugs or feature requests
  2. Submit Pull Requests: Improve the analytics or automation
  3. Share Ideas: Suggest new features or improvements
  4. Spread the Word: Tell others about this free civic tech solution

πŸ”’ Privacy & Security

  • No personal information stored
  • Anonymous user IDs only
  • Public repository for transparency
  • Community-driven data sharing
  • Read-only access for public data

πŸ“ž Support

  • GitHub Issues: Use this repository for questions
  • Documentation: Check the setup guide
  • Community: Engage with civic tech community
  • Contributions: Welcome pull requests and improvements

πŸŽ‰ Benefits

For Citizens

  • Transparent data storage
  • Community insights
  • Issue tracking
  • Impact measurement

For Government

  • Data-driven decision making
  • Resource allocation
  • Accountability tracking
  • Policy influence

For Community

  • Data-driven advocacy
  • Government accountability
  • Resource allocation
  • Policy influence

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

  • GitHub for providing free unlimited storage
  • GitHub Actions for free automation
  • Community for contributing reports and insights
  • Open source community for inspiration

This system gives you enterprise-level analytics capabilities at $0/month cost! 🎯

Made with ❀️ by @Mehonestperson


πŸ”— Links:


Star History Chart

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •