/codewars_readme_stats

Display your codewars stats on your github profile 🚀

Primary LanguageGoMIT LicenseMIT

Codewars readme stats

Display your codewars stats at your github readme profile!

Service Status

Currently down 🙃

Basic Example

Just replace USERNAME in the string below by your codewars username and copy-paste it to your github profile readme.

![Codewars](https://github.r2v.ch/codewars?user=USERNAME)

Codewars

Query params

You can add the following query params to the base url: https://github.r2v.ch/codewars

parameter requierd describtion example
username yes used to get the user info from codewars username=foo
name no if set to true the codewars name (nickname) is used on the card instead of the username name=true
top_languages no extens the crad with 3 icons of the top trained languages top_languages=true
stroke no sets a border with the passed in color around the card stroke=black
stroke=rgb(0,0,0)
stroke=%23000000
theme no sets a theme for the card theme=light
theme=dark
hide_clan no removes the clan name from the card hide_clan=true

Examples for all query params

Display nickname

![Codewars](https://github.r2v.ch/codewars?user=USERNAME&name=true)

Codewars

Top trained languages icons

![Codewars](https://github.r2v.ch/codewars?user=USERNAME&top_languages=true)

Codewars

Set card border

![Codewars](https://github.r2v.ch/codewars?user=USERNAME&stroke=%23BB432C)

⚠️ Important: You can pass in the usual css color types just make sure to use %23 instead of # while using hex code because of the url encoding

Codewars

Themes

This allows you to change de default codewars like theme. You can find a example of all themes here.

![Codewars](https://github.r2v.ch/codewars?user=dinifarb&theme=light)

Codewars

If you wish for other themes I am happy to take a pull request, just place your desired color set in the themes.go and themes.md file and your ready to go for the PR.

Hide Clan

![Codewars](https://github.r2v.ch/codewars?user=USERNAME&hide_clan=true)

⚠️ Important: This feature will eventually be expanded in a way to hide other infos like honor from the card. Therefore it is not guaranteed that it will stay exact the same.

Codewars

All params together

![Codewars](https://github.r2v.ch/codewars?user=USERNAME&name=true&top_languages=true&stroke=%23b362ff&theme=purple_dark)

Codewars

Link to when clicked

The pattern for linking svg content ![name](link to svg) can be wrapped in []() markdown option to link somewhere when clicked.

[![Codewars](https://github.r2v.ch/codewars?user=USERNAME)(LINK)]

Codewars

As Image

Optional to the svg ref markdown style it is possible to load the card as image. This gives you the possibility to center it as example.

<p align="center" >
    <a href="LINK TO: WHEN CLICKED">
      <img src="https://github.r2v.ch/codewars?user=USERNAME" />
    </a>
</p>

Host it on your own

In case you want to run this service on your own server you can use the docker image. The image is available on dockerhub.

Try it out with:

docker run -it -p 3000:3000 dinifarb/codewars

Or just clone this repo and do whatever you want with it.😉

Additional