Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.35 KB

readme.md

File metadata and controls

51 lines (33 loc) · 1.35 KB
Raw

Allegro Hacktoberfest Dashboard

Dashboard with stats of pull requests made during hacktoberfest by Allegro employees.

See current stats: https://hacktoberfest.allegro.tech/ (the page is updated every 10 minutes).

Read more about hacktoberfest

Develop locally

Node and npm in recent versions are required.

To install dependencies run:

$ npm i

To run locally (with live preview):

$ npm run start

If you want to update current contributions run:

$ export TOKEN=GITHUB_PERSONAL_ACCESS_TOKEN
$ npm run prebuild

Run in production

To generate static page run:

$ export TOKEN="GITHUB_PERSONAL_ACCESS_TOKEN"
$ npm ci
$ npm run build

Note, that this is a static page and contributions are fetched on build by a npm task prebuild and a TOKEN variable is used to access GitHub api.

Project data

In src/data directory there are json files with input data.

  • /users/{year}.json files are used to store participants info and fetch their pull requests
  • contributions.json is a list of pull requests made by participants, it stores historical data. Current data is updated by npm prebuild task.
  • inspirations.json list of inspirations to display on inspirations tab
  • repositories.json list of opensource repositories to display on inspirations tab