https://github.com/becodeorg/kareble
⚙️ An overview of all BeCodian's Contributions on GitHub
https://github.com/becodeorg/kareble
graphql internal-tool sveltejs
Last synced: about 2 months ago
JSON representation
⚙️ An overview of all BeCodian's Contributions on GitHub
- Host: GitHub
- URL: https://github.com/becodeorg/kareble
- Owner: becodeorg
- Created: 2019-05-25T11:58:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:51:52.000Z (over 2 years ago)
- Last Synced: 2025-01-10T12:11:25.415Z (3 months ago)
- Topics: graphql, internal-tool, sveltejs
- Language: Svelte
- Homepage: http://kareble.becode.xyz
- Size: 2.5 MB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BeCode: [kareble](http://kareble.becode.xyz)
> ⚙️ An overview of all BeCodian's Contributions on GitHub
* * *
## About
Just a _pet_ project to play with [GitHub's **GraphQL** API](https://developer.github.com/v4/explorer/) and [**SvelteJS**](http://svelte.dev/): displaying the same "Green squares' overview of contributions", but for all members of BeCode teams.
## Installation & usage
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](http://rollupjs.org)
### Fetching the data
To fetch and parse the data, use the following command :
npm run fetch:data YOUR_PERSONNAL_ACCESS_TOKEN
> ☝️ **NOTE:** you'll need to [generate](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) 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.
### Build / run the app
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](http://localhost:5000)) and a rollup process to watch your changes in the sources to rebuild.
### Deploy
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.