Talawa Leaderboard

A Flutter application that displays a leaderboard of GitHub Pull Request contributions for the Palisadoes Foundation's projects. This tool helps track and visualize contributor activity across repositories.

Features

• Real-time GitHub PR statistics
• Contributor rankings based on PR activity
• Clean and modern Material Design UI
• Responsive layout for various screen sizes
• Secure GitHub token management

Prerequisites

Before running the application, make sure you have the following installed:

• Flutter (latest stable version)
• Git
• A code editor (VS Code, Android Studio, etc.)

Setup Instructions

1. Clone the repository:

   git clone https://github.com/PalisadoesFoundation/talawa-leaderboard.git
   cd talawa-leaderboard

2. Install dependencies:

   flutter pub get

3. Set up environment variables:

   • Copy the .env_copy file to create a new .env file:

     cp .env_copy .env

   • Edit the .env file and replace your_github_token_here with your GitHub Personal Access Token
   • To create a GitHub token:
     1. Go to GitHub Settings > Developer Settings > Personal Access Tokens
     2. Click "Generate new token"
     3. Select the necessary scopes (repo access is required)
     4. Copy the generated token and paste it in your .env file

4. Run the application:

   flutter run

Project Structure

lib/
├── core/                     # Core functionality
│   ├── constants/           # Application constants
│   ├── models/             # Data models
│   └── services/           # API services
└── features/               # Feature modules
    └── leaderboard/       # Leaderboard feature
        ├── repositories/  # Data repositories
        ├── view_models/   # View models
        └── views/        # UI components

Contributing

1. Fork the repository
2. Create a new branch for your feature
3. Make your changes
4. Submit a pull request

Resources

• Flutter Documentation
• GitHub API Documentation
• Palisadoes Foundation

License

This project is licensed under the terms specified by the Palisadoes Foundation.