Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ishandeveloper/github-wrapped

Take a look back at all the contributions you as an individual made to the open-source community
https://github.com/ishandeveloper/github-wrapped

2020 2020-2021 github github-api graphql javascript lookback react stats tech tweets wrapup year yearbook

Last synced: 2 months ago
JSON representation

Take a look back at all the contributions you as an individual made to the open-source community

Awesome Lists containing this project

README

        





Generate your report



#### Why do I exist?
### 2020 has been a challenging year for all of us.

As the year is ending, we thought to take a look back at all the contributions **you** as an individual
made to the open-source community, during these unprecedented times.

Also, since Spotify, Snapchat and other mass platforms have their own way of year wrap up, **why not us?**

githubwrapped.tech


### Reports

This web app deployed at [githubwrapped.tech](https://githubwrapped.tech) will help you to generate yearly reports that contains your stats from the beginning of this year.

Including number of commits, stars etc.

Sample GitHub Wrapped Report

You can also save your report as an image using the 'Save Report' button and share it with the community or keep it as a memorandum :)


#### Project Structure

This project uses [React.Js](https://reactjs.org) and the contents are bundled using webpack.

The contents in this project follow the following structure.

```
├───api
├───public
│ └───assets
└───src
├───components
├───constants
├───containers
└───helpers
```

Each individual component and container, follows this structure
```
section
├──index.jsx (main entry point)
└──style.scss
```

### Tweet Bot

The celebrations doesn't end here! We also our own cute octo-bot on twitter [@GitHubWrapped](https://twitter.com/GitHubWrapped).



Octobot stays awake all day/night to like & retweet all your tweets that use the hashtag #GitHubWrapped.

## Setup

##### Clone the repository

```bash
git clone https://github.com/ishandeveloper/github-wrapped.git
```

##### Move to the desired folder

```bash
cd \github-wrapped
```

##### To install the dependencies, simply write

```bash
yarn install
```

##### To run the app, simply write

```bash
yarn start
```

### Maintainers ✨



Ishan Sharma




Himanshu Sharma



[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/ishandeveloper)