https://github.com/rocketchat/opensource-contribution-leaderboard
Open Source project contributors tracking leaderboard built with :heart: in NodeJS 😉
https://github.com/rocketchat/opensource-contribution-leaderboard
community-building community-management gsoc gsoc-contribution-leaderboard leaderboard nodejs opensource-projects students
Last synced: 7 months ago
JSON representation
Open Source project contributors tracking leaderboard built with :heart: in NodeJS 😉
- Host: GitHub
- URL: https://github.com/rocketchat/opensource-contribution-leaderboard
- Owner: RocketChat
- License: mit
- Created: 2019-04-22T08:23:43.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-08T12:58:21.000Z (over 2 years ago)
- Last Synced: 2024-05-01T11:29:33.269Z (about 2 years ago)
- Topics: community-building, community-management, gsoc, gsoc-contribution-leaderboard, leaderboard, nodejs, opensource-projects, students
- Language: JavaScript
- Homepage: https://gsoc.rocket.chat
- Size: 1.32 MB
- Stars: 38
- Watchers: 7
- Forks: 46
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Introduction
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](https://github.com/RocketChat).
## Benefits
- Encourage contributors to improve their position - by increasing contribution to your organization
- Easy to setup and administer
- Realtime organization - wide visibility to top contributors.
## Main Features
- 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.
## Deploy with Docker
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](https://hub.docker.com/r/rohanlekhwani/opensource-contribution-leaderboard)
```
docker pull rohanlekhwani/opensource-contribution-leaderboard:latest
```
and then run
```
docker run -p 8080:8080 -d rohanlekhwani/opensource-contribution-leaderboard
```
## Quick Start
Clone the repository to your local machine and switch into the project root directory:
````bash
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:
````bash
{
"organization": "OrgName",
"organizationHomepage": "https:///",
"organizationGithubUrl": "https://github.com/",
"authToken": "",
"adminPassword": "123456",
"delay": "10",
"serverPort": "62050",
"contributors": []
}
````
Then switch to the project root directory, install the dependencies:
````bash
cd ../../
npm run add
````
And then you can read [Development](#development) part or [Production](#production) part for the next step.
## Development
Switch your path to the project base directory:
````bash
npm start
````
You will see the GSOC Contribution Leaderboard in the [http://localhost:8080](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:
````bash
npm run serve
````
**Note:** If the backend service is not started, the contributions data will not be refreshed.
### Develop Administration Panel
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:
````bash
cd admin
npm start
````
## Production
Generate the static files first by running the following command:
````bash
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
````
## Automated Data Fetch REST API
REST API endpoints are available to fetch important leaderboard data real-time.
The API uses the cached `data.json` file which is created and regularly updated on starting up the server. This means that if the API is called in the middle of a data fetch cycle, the data returned by it at any time would be based off the data present in the `data.json` at that time. Since the leaderboard itself displays data using the `data.json` file, the data fetched by the API and that displayed on the leaderboard will *always be consistent* at any given time.
Details about the API endpoints and their responses can be found in the [REST-API](/REST-API.md) file.
## Acknowledgement
This project is inspired by [GSOC-Contribution-Leaderboard](https://github.com/shubhsherl/GSoC-Contribution-Leaderboard/). Thanks to the Python team for the work.
## License
This project is open source under the Licence [MIT](./LICENSE).