⚙️ An overview of all BeCodian's Contributions on GitHub

Just a pet project to play with GitHub's GraphQL API and SvelteJS: displaying the same "Green squares' overview of contributions", but for all members of BeCode teams.

Run npm install to install the dependencies of the project.

The codebase is divided in two parts :

• a script to fetch the users' data from the GitHub API and parse them into a structured JSON file
• the Svelte SPA, used to render the JSON file onto front-end components, built with Rollup

To fetch and parse the data, use the following command :

npm run fetch:data YOUR_PERSONNAL_ACCESS_TOKEN

☝️ NOTE: you'll need to generate a GitHub Personnal access token with the following scopes: admin:org, repo, user

⚠️ The script can take up to two minutes to run. Be patient.

All the code for the app is inside the src folder.

To build the app (for production purposes), simply run npm run build.
The compiled result is inside the public folder.

You can also use the npm run work command to run a local preview server (localhost:5000) and a rollup process to watch your changes in the sources to rebuild.

The app is hosted on GitHub Pages. Simply run npm run deploy (after a build) to deploy the app.

👉 NOTE: a GitHub Actions Workflow is configured to fetch data, build & deploy the code every sunday.

May 2019, leny.