Skip to content

README.md

Latest commit

 

History

History
56 lines (40 loc) · 2.02 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.02 KB

Community Raffle

Use this template

A template repository to run fair, transparent, and automated raffles for your community events using GitHub Issues and GitHub Actions.

✨ Features

  • Zero Hosting Costs: Runs entirely on the GitHub platform
  • Transparent & Fair: All entries and winner selections are public in the issue comments
  • Fully Automated: QR code generation and winner selection are handled by GitHub Actions
  • Easy to Use: Simple issue form to create new raffles
  • Community Engagement: Encourages interaction directly on GitHub

🚀 Quick Start

  1. Use This Template: Click the "Use this template" button above and name your repository raffle

  2. Enable GitHub Actions: Go to Settings > Actions > General and select "Allow all actions and reusable workflows"

  3. Create Your First Raffle:

    • Go to the Issues tab
    • Click New issue
    • Select the 🎉 New Raffle Event template
    • Fill out the form and submit

📋 How to Run a Raffle

Creating a Raffle:

Fill out the raffle template with:

  • Event Name: Descriptive name for your raffle
  • Number of Winners: How many people will win
  • Prize Details: What winners will receive

What Happens Automatically:

  • ✅ Issue title gets updated with your event name
  • ✅ QR code is generated for easy sharing
  • ✅ Ready to accept participants via comments

Selecting Winners:

  1. Go to the Actions tab
  2. Find "Raffle Winner Selection"
  3. Click "Run workflow"
  4. Select your raffle from the dropdown menu
  5. Winners are announced automatically

Tips:

  • Share the issue URL or QR code with participants
  • Set clear entry deadlines in your raffle description
  • Pin the raffle issue to make it visible
  • Close the issue after distributing prizes

📄 License

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