A tool for Wikimedia community members to visualize their technical contributions
MIT License
WikiContrib is a tool for Wikimedia community members to visualize their technical contributions within a specified time range. Currently, the tool gathers statistics from Phabricator (task management system) and Gerrit (code collaboration platform).
This project was proposed in the Google Summer of Code 2019 and developed as an internship project by Rammanoj Potla. It also received small improvements from students as part of the Google Code-in contest.
Technologies used: Django (Python), React (Javascript)
WikiContrib is participating in Outreachy Round 20. Some of the features planned for the Outreachy project "Gather and analyze user contributions on wiki & Github" and for the future to enhance the project are:
To view a community members’ contributions, provide their full name, Gerrit username, and Phabricator username. By default, the tool searches for their contributions in the past year. There are options to filter by timestamp and issue type (for example: merged, open, etc.) There is also a feature to upload a list of usernames in a CSV format and view contributions for several community members altogether (this feature is still in experimental mode).
git clone https://github.com/wikimedia/WikiContrib.git
cd WikiContrib
pip install docker-compose
backend/WikiContrib/WikiContrib/.env.example
to a new file backend/WikiContrib/WikiContrib/.env
. Update it! Most likely you will be making changes only to DB_NAME
, DB_USER
, DB_PASSWORD
and PHAB_KEY
variables.docker-compose up --build
.localhost:3000
and backend running at localhost:8000
--build
flag only when running docker-compose for the first time. For repeated use, simply run docker-compose up
. This will not reflect the changes you made in you local project setup.This tool has two different components: Frontend & Backend. You will have to set up both for the tool to be fully functional, and the instructions do so are here:
DEPLOYING.md
This project is licensed under the MIT LICENSE