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

https://github.com/asrvd/octocolor

🌈 what's your GitHub profile color?
https://github.com/asrvd/octocolor

chakra chakra-ui github-profile octocolor octoprofile react vite

Last synced: 21 days ago
JSON representation

🌈 what's your GitHub profile color?

Awesome Lists containing this project

README

        

# 🌈OctoColor


πŸ€” Wanna know what's your GitHub Profile Color?\
🐱 Head over to https://octocolor.vercel.app

## πŸ±β€πŸ’» How does GitColor work?

The idea is simple. We get the language info for all of a user's GitHub Repositories using [GhPolyGlot](https://github.com/IonicaBizau/node-gh-polyglot) and then we use the top 2 languages as a reference to determine the color of the user's GitHub profile. Once we get the info about the top 2 languages, we blend the the colors using the [Mix CSS Color](https://www.npmjs.com/package/mix-css-color) library. Then we simply use [Name that Color](https://chir.ag/projects/name-that-color/) library to get the name of the unique color generated by the app. And we're done! πŸš€

## πŸš€ Running Locally

Clone the repos's main branch.
```sh
$ git clone -b main https://github.com/asheeeshh/octocolor.git
```
Install dependencies, make sure you have `nodejs` and `npm` installed.
```sh
$ npm install
```
Run the app.
```sh
$ npm run dev
```

## βš– License
MIT License

## βœ’ Ending Note
- *Consider giving the repo a ⭐ if you liked the project!*
- *Follow me and checkout my other projects!*