An open source contributors leaderboard for your developers community, Github organization, or Google Summer of Code (GSoC) organization. Contributors can track their position on the leaderboard based on the PRs, commits, and issues they've completed across the repositories of interest across your Github organization . Proudly created and maintained by the GSoC 2019-2021 students and the wider Rocket.Chat community.
- Encourage contributors to improve their position - by increasing contribution to your organization
- Easy to setup and administer
- Realtime organization - wide visibility to top contributors.
- Track commits/PRs/issues for contributors and GSoC student candidates in real time
- At a glance view of participating top students
- Easy administration to add students (even before they have made their very first contribution)
- Requires no database or other environments - Only what you need to do is to ensure that your Node.js works well
- Real-time updation of results - Contributions get updated real-time after server start without the need to refresh.
Use docker-compose
to deploy directly
docker-compose up -d
The configuration file (src/server/config.json
) can be easily modified locally to reflect changes on the container. The data gets backed up at /data
inside the container.
OR Use the automated build image of our most recent release
docker pull rohanlekhwani/opensource-contribution-leaderboard:latest
and then run
docker run -p 8080:8080 -d rohanlekhwani/opensource-contribution-leaderboard
Clone the repository to your local machine and switch into the project root directory:
git clone git@github.com:RocketChat/Opensource-Contribution-Leaderboard.git
cd Opensource-Contribution-Leaderboard
Copy config-example.json
to config.json
in the src/server directory. Add your Github Auth Token and Organization name and other keys in it as following:
{
"organization": "OrgName",
"organizationHomepage": "https://<OrgName>/",
"organizationGithubUrl": "https://github.com/<OrgName>",
"authToken": "",
"adminPassword": "123456",
"delay": "10",
"serverPort": "62050",
"contributors": []
}
Then switch to the project root directory, install the dependencies:
cd ../../
npm run add
And then you can read Development part or Production part for the next step.
Switch your path to the project base directory:
npm start
You will see the GSOC Contribution Leaderboard in the http://localhost:8080 if all works well. Then open a new terminal window (or tab) and enter the following commands to start your backend service:
npm run serve
Note: If the backend service is not started, the contributions data will not be refreshed.
You need to start another instance if you'd like to develop administration panel, open a new terminal window (or tab) and try following commands:
cd admin
npm start
Generate the static files first by running the following command:
npm run build
cd dist/server
npm install pm2 -g # run this command on your server if pm2 is not installed.
pm2 start app.js --name "GSOC-Contribution-Leaderboard" # start the backend service
This project is inspired by GSOC-Contribution-Leaderboard. Thanks to the Python team for the work.
This project is open source under the Licence MIT.