Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/iampavangandhi/Gitwar

🚀 Gitwar - Compete with Github ( ⚠️ NOT ACTIVELY MAINTAINED )
https://github.com/iampavangandhi/Gitwar

express expressjs github github-api github-profile github-stats heroku heroku-deployment labels node node-js profile stars stats

Last synced: about 2 months ago
JSON representation

🚀 Gitwar - Compete with Github ( ⚠️ NOT ACTIVELY MAINTAINED )

Awesome Lists containing this project

README

        

# ⚠️ NOT ACTIVELY MAINTAINED

---

![logo](./public/logo.png)

# **Gitwar - Compete with Github**

![Version](https://img.shields.io/github/package-json/v/iampavangandhi/Gitwar?color=2948ff&label=Version&style=flat-square) ![License](https://img.shields.io/github/license/iampavangandhi/Gitwar?color=2948ff&label=License&style=flat-square) ![Deployment](https://img.shields.io/github/deployments/iampavangandhi/Gitwar/gitwar?color=2948ff&label=Deployment&style=flat-square) ![Repo Size](https://img.shields.io/github/repo-size/iampavangandhi/Gitwar?color=2948ff&label=Repo%20Size&style=flat-square)

## Website : https://gitwar.up.railway.app

---


# Gitwar WebApp

> ### Website : https://gitwar.herokuapp.com/

## 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](https://shields.io/)
> ### Check [utils/calc.js](./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:

```markdown
![](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` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=brightgreen) |
| `green` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=green) |
| `yellow` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=yellow) |
| `orange` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=orange) |
| `red` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=red) |
| `blue` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=blue) |
| `grey` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=grey) |
| `lightgrey` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=lightgrey) |
| `blueviolet` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=blueviolet) |
| `ff69b4` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=ff69b4) |

**Named color**

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

**Hex color**

```markdown
![](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` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=007ec6&style=plastic) |
| `flat` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=007ec6&style=flat) |
| `flat-square` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=007ec6&style=flat-square) |
| `for-the-badge` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=007ec6&style=for-the-badge) |

```markdown
![](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://img.shields.io/static/v1?label=GITWAR+PROFILE+SCORE&message=1234567890&color=007ec6)

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

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

---

## Local Setup

```sh
# 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](https://github.com/huchenme) for the [Github Trending Api](https://github.com/huchenme/github-trending-api)

## Deployment

#### Deploy it on your own Heroku Dyno to avoid downtime.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Contributing

Feel free to dive in! [Open an issue](https://github.com/iampavangandhi/Gitwar/issues/new) or submit PRs

## License

[MIT](LICENSE) © Pavan Gandhi

---

### Show some ❤️ by starring 🌟 the repository!