Skip to content

codeforpakistan/civic-issue-finder

Repository files navigation

Civic Issue Finder

A modern take on Code for America's original Civic Issue Finder. This tool helps connect developers with meaningful civic tech opportunities by aggregating GitHub issues labeled as civic-tech-issue.

Civic Issue Finder Screenshot

Features

  • 🔍 Browse open civic tech issues from GitHub
  • 🏷️ Filter by programming language
  • 📱 Responsive design for all devices
  • 🌙 Dark mode support
  • 🔌 Embeddable widget for other websites
  • 🚀 Built with modern web technologies
  • 📊 API for integrating into other applications

Getting Started

Prerequisites

  • Node.js 18+
  • GitHub Personal Access Token
  • Airtable account (for problem statements)

Installation

  1. Clone the repository:
git clone https://github.com/your-repo/civic-issue-finder.git
cd civic-issue-finder
  1. Install dependencies:
npm install
  1. Create a .env.local file with the following variables:
NEXT_PUBLIC_APP_URL=http://localhost:3000
GITHUB_PAT=your_github_pat
AIRTABLE_PAT=your_airtable_pat
AIRTABLE_BASE_ID=your_base_id
  1. Run the development server:
npm run dev
  1. Open your browser and navigate to http://localhost:3000 to see the app in action.

Embedding

To embed the issue finder on your website, use the provided embed code. You can customize the height and theme (light or dark) using the URL parameters.

<iframe src="https://civicissuefinder.codeforpakistan.org/embed" width="100%" height="500px"></iframe>

API

The API is available at https://civicissuefinder.codeforpakistan.org/api/v1/issues. It returns a JSON object with the issues, including pagination support.

Get civic tech issues
GET /api/v1/issues


Query parameters
?page=1 # Page number
?per_page=12 # Items per page
?language=python # Filter by language

Contributing

  1. Label your GitHub issues with civic-tech-issue to include them in the finder
  2. Follow our contribution guidelines
  3. Submit pull requests for improvements

Built With

License

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

Acknowledgments

  • Inspired by Code for America's original Civic Issue Finder
  • Built for the civic tech community
  • Maintained by Code for Pakistan

About

The easiest way to get started with civic hacking.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published