avisionx / sourcerer-profile-chart

:octocat:📊 Micro service to generate sourcerer profile charts as images to embed in your github profiles & websites for free forever

Sourcerer Profile Chart

This repository generates sourcerer profile chart png from website ✨
Explore the docs »
View Demo . Request Feature

Table of Contents

• Add to your Profile
• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

Add to your Profile

Easiest way to add chart to your Github like https://github.com/avisionx is by creating a pull request and adding your username in username.js. I'll merge the PR really soon then you can simply go on using your own chart like shown below in Usage section, it will be updated weekly and will be free forever 😄 or to set it up yourself goto Installation section.

About The Project

There are a lot of stats tracker for Github Readme available online, however, I didn't find one that was free and covered all data so I extracted one from sourcerer.io

Here's why:

• Cause I needed it, Duh!
• Also free to host and use 😄

Built With

This project was built with nodejs and is powered by github actions for cron job tasks. 🤩

Getting Started

To get up and running with this project on your local machine follow these simple steps.

Prerequisites

Here's a list of things you'll need to have prior to generating the stats

• Account on Sourcerer like so https://sourcerer.io/avisionx
• Node Js v8+

Installation

1. Clone the repo

$ git clone https://github.com/avisionx/sourcerer-profile-chart.git

2. Install node packages

$ npm install

3. Change/Add your sourcerer_username in usernames.js to generate statistics for yourself.

usernames = ["avisionx"]; // for single user
usernames = ["avisionx", "another_user", "many_more" ...] // for multi_user

4. Generate image

$ npm start

Usage

Use Raw image from Github replace avisionx with your username if you have cloned the repo entirely else replace avisionx-sourcerer-chart.png only.

<img src="https://raw.githubusercontent.com/avisionx/sourcerer-profile-chart/master/charts/avisionx-sourcerer-chart.png" />

OR

![avisionx-sourcerer-chart](https://raw.githubusercontent.com/avisionx/sourcerer-profile-chart/master/charts/avisionx-sourcerer-chart.png)

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Avi Garg - https://avisionx.net/ - [e-mail]

Project Link: https://github.com/avisionx/sourcerer-profile-chart