Maakaf / maakaf-website

The official website of 'Maakaf' community
https://maakaf-website.vercel.app
MIT License
20 stars 52 forks source link

Leader Board - GitHub Activity - Gamify #261

Open barel-mishal opened 6 months ago

barel-mishal commented 6 months ago

Hello Community,

We are excited to share an idea to add a new feature to our community and complete it within the next month. This feature aims to connect our community and create an enjoyable and educational environment.

The idea is to create a leaderboard that tracks our shared projects on GitHub. This tool can encourage active participation in open-source projects, foster collaboration, and provide personal recognition for everyone’s contributions.

The leaderboard will showcase top contributors, the number of commits, merges, and other relevant metrics, creating a friendly environment that motivates everyone to get more involved in the projects.

Project Tasks

1.  Project Registration: Set up a daily registration system to pull data from GitHub.
2.  Automatic Function: Operate a daily automatic data pull. The data includes:
•   Number of merges
•   Number of commits
•   Timing of actions and data pull
•   Opening issues
3.  UI Interface:
•   Display an image of the first letter of the user’s name (or a GitHub image if possible).
•   Create a UI for the leaderboard.
•   A success page after adding a project, including a back button to the dashboard.
4.  Data Storage: Use the simplest, cheapest, and easiest way to store data.
5.  Data Integration: Pull data into the application from the data source.
6.  Full Typing.
7.  Integration Tests.
8.  New Project Registration Page.
9.  Add Project Button: Click -> Register via GitHub -> Approve data pull -> Automatically pull data once approved.
10. Add Tasks: Add tasks to the data repository based on identified needs.

We welcome suggestions and opinions and would love to see you take part in this important project. Let’s create an enjoyable and educational work environment that helps us all grow and contribute to the community.

Looking forward to continuing our conversation face-to-face in the open chat.

barel-mishal commented 6 months ago

I have added a branch called maakaf-leaderboard to merge all the changes over there before we merge it with main. Here is the link: https://github.com/Maakaf/maakaf-website/tree/maakaf-leaderboard

UrielOfir commented 6 months ago

Is it OK that I've assigned you to this issue?

barel-mishal commented 5 months ago

Update! Great news, we are close to finishing.

Here’s what has been done so far:

1.  Implemented and tested the logic for database merging: GitHub Link
2.  Implemented a design: Pending final touches from the designer.
3.  Database now saves the leaderboard data needed for persistence.

Currently, we are observing only commits, additions, and deletions of the code. To more accurately reflect contributions, we should consider observing more metrics. I encourage and invite you to discuss what other metrics we could observe to better measure our contributions.

Let’s continue to work together to improve and enhance our community!