Skip to content

Latest commit

 

History

History
158 lines (101 loc) · 5.38 KB

README.md

File metadata and controls

158 lines (101 loc) · 5.38 KB

⚠️ NOT ACTIVELY MAINTAINED


logo

Gitwar - Compete with Github

Version License Deployment Repo Size



Gitwar WebApp

Features

  • Check your Github Score. Based on -
    • Your Public Repos
    • Stars on Public Repos
    • Forks on Public Repos
    • Github Followers
    • Joined Github Organisations
  • Compete with Friends and Other Github Users
  • View Trending Repos of 5 Different Languages

Gitwar Score in README

Add Gitwar Score to GitHub Profile README

Badges are Powered by Shield.io

Check utils/calc.js to Know How Gitwar Score is Calculated

You need to add this in README.md file in your profile repository via Markdown syntax:

![](https://gitwar.herokuapp.com/badge?username=your-github-username)

NOTE: Don't forget to replace example your-github-username parameter with real value.

Make it personal

Color

You can use any valid HEX color or pick from a predefined set of named colors (blue is the default).

color demo
brightgreen
green
yellow
orange
red
blue
grey
lightgrey
blueviolet
ff69b4

Named color

![](https://gitwar.herokuapp.com/badge?username=your-github-username&color=green)

Hex color

![](https://gitwar.herokuapp.com/badge?username=your-github-username&color=dc143c)

NOTE: HEX colors should be used without # symbol prefix.

Styles

The following styles are available (flat is the default).

style demo
plastic
flat
flat-square
for-the-badge
![](https://gitwar.herokuapp.com/badge?username=your-github-username&style=flat-square)

Label

You can overwrite default Gitwar Score text with your own label.

![](https://komarev.com/ghpvc/?username=your-github-username&label=PROFILE+VIEWS)

NOTE: Replace whitespace with + character in multi-word labels.


Local Setup

# install dependencies
npm install

# serve at localhost:3000
npm start

# serve with hot reload at localhost:3000
npm run dev

Tech Stack

  • Expressjs (Nodejs)
  • Axios (HTTP client)
  • EJS (Template Engine)
  • Github API
  • Heroku for deployment

API Credits

Special Thanks to Huchenme for the Github Trending Api

Deployment

Deploy it on your own Heroku Dyno to avoid downtime.

Deploy

Contributing

Feel free to dive in! Open an issue or submit PRs

License

MIT © Pavan Gandhi


Show some ❤️ by starring 🌟 the repository!