https://github.com/allegro/hacktoberfest-dashboard
Allegro Hactoberfest activity dashboard
https://github.com/allegro/hacktoberfest-dashboard
hacktoberfest
Last synced: 6 months ago
JSON representation
Allegro Hactoberfest activity dashboard
- Host: GitHub
- URL: https://github.com/allegro/hacktoberfest-dashboard
- Owner: allegro
- License: other
- Created: 2019-10-24T09:05:58.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T03:10:53.000Z (about 1 year ago)
- Last Synced: 2025-04-08T03:35:30.656Z (8 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://hacktoberfest.allegro.tech
- Size: 10.9 MB
- Stars: 24
- Watchers: 2
- Forks: 29
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Allegro Hacktoberfest Dashboard
Dashboard with stats of pull requests made during hacktoberfest by [Allegro](https://allegro.tech/) employees.
See current stats: https://hacktoberfest.allegro.tech/ (the page is updated every 10 minutes).
Read more about [hacktoberfest](https://hacktoberfest.com/)
## Develop locally
Node and npm in recent versions are required.
To install dependencies run:
```bash
$ npm i
```
To run locally (with live preview):
```bash
$ npm run start
```
If you want to update current contributions run:
```bash
$ export TOKEN=GITHUB_PERSONAL_ACCESS_TOKEN
$ npm run prebuild
```
## Run in production
To generate static page run:
```bash
$ 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