<NME> README.md
<BEF> # [Clash Royale API](http://www.clashapi.xyz/)

[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master) [![bitHound Overall Score](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/score.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api) [![bitHound Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/dependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Dev Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/devDependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/code.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api)
[![donate paypal](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/MartinCarrera)

A [Clash Royale](http://supercell.com/en/games/clashroyale/) API that provides information about the game.

> If you develop an app using this API, please submit a pull request adding it to the [apps table](#apps-that-use-this-api).

## Content

1. [How to use](#how-to-use)
    1. [Endpoints](#endpoints)
    2. [Images](#images)
2. [Want to help](#want-to-help)
3. [Development](#development)
    1. [Install](#install)
    2. [Run](#run)
    3. [Test](#test)
4. [Apps that use this API](#apps-that-use-this-api)

## How to use

Consume the API to get all the information you need from these routes.

### Endpoints

[Base route](http://www.clashapi.xyz).

| Route | HTTP Verb | Description |
|---|---|---|
| [`/api/arenas`][1] | `GET` | All Arenas information |
| `/api/arenas/:id` | `GET` | Single Arena information |
| `/api/arenas/:idName` | `GET` | Single Arena information |
| [`/api/cards`][2] | `GET` | All Cards information |
| `/api/cards/:id` | `GET` | Single Card information |
| `/api/cards/:idName` | `GET` | Single Card information |
| [`/api/chests`][3] | `GET` | All Chests information |
| `/api/chests/:id` | `GET` | Single Chest information |
| `/api/chests/:idName` | `GET` | Single Chest information |
| [`/api/leagues`][4] | `GET` | All Leagues information |
| `/api/leagues/:id` | `GET` | Single League information |
| `/api/leagues/:idName` | `GET` | Single League information |
| [`/api/players`][5] | `GET` | All Players levels information |
| `/api/players/:id` | `GET` | Player level information |
| `/api/players/:idName` | `GET` | Player level information |
| [`/api/random-deck`][6] | `GET` | Get a Random deck! |

[1]: http://www.clashapi.xyz/api/arenas
[2]: http://www.clashapi.xyz/api/cards
[3]: http://www.clashapi.xyz/api/chests
[4]: http://www.clashapi.xyz/api/leagues
[5]: http://www.clashapi.xyz/api/players
[6]: http://www.clashapi.xyz/api/random-deck

### Images

You can get the images too! Thank you [MaherFa](https://github.com/MaherFa)!

| Route | Description |
|---|---|
| [`/images/arenas/${idName}.png`][7] | Arenas images |
| [`/images/cards/${idName}.png`][8] | Cards images |
| [`/images/chests/${idName}.png`][9] | Chests images |
| [`/images/leagues/${idName}.png`][10] | Leagues images |

[7]: http://www.clashapi.xyz/images/arenas/royal-arena.png
[8]: http://www.clashapi.xyz/images/cards/arrows.png
[9]: http://www.clashapi.xyz/images/chests/super-magical-chest.png
[10]: http://www.clashapi.xyz/images/leagues/ultimate-champion.png

## Want to help

If you like the API, please star this repository.

If you create an app using the API, please mention this repository and add it in the table below.

If you want to contribute to the API, feel free to create a pull request.

If you :heart: the API, [help me pay the hosting](https://www.paypal.me/MartinCarrera)!

## Development

Make sure you have installed all these prerequisites on your development machine.

* [Node.js](https://nodejs.org/en/download/)
* [MongoDB](https://www.mongodb.org/)
* [Nodemon](https://nodemon.io/)

### Install

```bash
> git clone https://github.com/martincarrera/clash-royale-api.git
> cd clash-royale-api
> npm install
```

### Run

```bash
> mongod
> cd clash-royale-api
> npm run dev
```

If you don't have `Nodemon` installed

```bash
> mongod
> cd clash-royale-api
> npm i -g nodemon
> npm run dev
```

### Test

```bash
> npm test
```

## Apps that use this API

| APP | DESCRIPTION | LINK |
|:---:|:---:|:---:|
| Randeck | Simple web app that generates random decks. | [Go!](http://randeck.xyz) |
| Royale Plus | Facebook for Clash Royale players. | [Git!](https://github.com/AmirSavand/royale-plus) [Go!](http://royplus.herokuapp.com/)|
| BarrePolice | A Telegram Bot based on plugins written in Lua |[Go!](https://t.me/BarrePolice_Bot) _& send /cr_ |
| Clashapi | NPM package to consume this API | [Go!](https://www.npmjs.com/package/clashapi) |
| Deck it | Deck builder app designed for Android | [Go!](https://play.google.com/store/apps/details?id=com.oryginal.deckit) |
| Deck Generator for Echo Devices | Alexa skill to suggest a deck for clash royale for Amazon's Echo devices | [Go!](https://alexa.amazon.in/spa/index.html#skills/dp/B078WSRZWV/?ref=skill_dsk_skb_ca_24) |
| Clash Royale Discord Bot | A Discord bot that displays informations depending of commands | [Go!](https://github.com/TorzuoliH/clash-royale-discord-bot) |
| Deck Royale | A SPA using Vue that generates random decks. | [Git!](https://github.com/ikenami/Deck-Royale) [Go!](http://deck-royale-ultimate.herokuapp.com/) |
| ClashElite | Simple app that gives info on chest cycles and generates random decks with copy and share feature. | [Go!](https://play.google.com/store/apps/details?id=com.wordpress.redmanandroid.clashelite) |

Made with :heart: by clash fans.

----------
This content is not affiliated with, endorsed, sponsored, or specifically approved by Supercell and Supercell is not responsible for it. For more information see [Supercell’s Fan Content Policy](http://www.supercell.com/fan-content-policy).

<MSG> Remove bithound badges.
<DFF> @@ -1,6 +1,6 @@
 # [Clash Royale API](http://www.clashapi.xyz/)
 
-[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master) [![bitHound Overall Score](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/score.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api) [![bitHound Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/dependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Dev Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/devDependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/code.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api)
+[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master)
 [![donate paypal](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/MartinCarrera)
 
 A [Clash Royale](http://supercell.com/en/games/clashroyale/) API that provides information about the game.

{'commit': 'diff --git a/README.md b/README.md\nindex 00f159d..52fcef7 100644\n--- a/README.md\n+++ b/README.md\n@@ -1,6 +1,6 @@\n # [Clash Royale API](http://www.clashapi.xyz/)\n \n-[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master) [![bitHound Overall Score](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/score.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api) [![bitHound Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/dependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Dev Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/devDependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/code.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api)\n+[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master)\n [![donate paypal](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/MartinCarrera)\n \n A [Clash Royale](http://supercell.com/en/games/clashroyale/) API that provides information about the game.\n', 'commit_subject': 'Remove bithound badges.', 'repo_name': 'martincarrera/clash-royale-api', 'committer': {'name': 'GitHub', 'email': '1505422b2465e9a84f6fdfaa161078890c593f06@github.com', 'time_sec': '1528738866', 'tz_offset': '-180', 'date': {'seconds': '1528738866'}}, 'commit_tree': '168479ffafe07bac0e80b800462c711cd725c403', 'commit_message': 'Remove bithound badges.', 'language_name': 'JavaScript', 'license': 'mit', 'hunks': '@@ -1,6 +1,6 @@\n # [Clash Royale API](http://www.clashapi.xyz/)\n \n-[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master) [![bitHound Overall Score](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/score.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api) [![bitHound Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/dependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Dev Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/devDependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/code.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api)\n+[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master)\n [![donate paypal](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/MartinCarrera)\n \n A [Clash Royale](http://supercell.com/en/games/clashroyale/) API that provides information about the game.\n', 'addition_count': 1, 'deletion_count': 1, 'src_file': 'a/README.md', 'tgt_file': 'b/README.md', 'file_extension': '.md', 'before_file': "# [Clash Royale API](http://www.clashapi.xyz/)\n\n[![Codeship Status for martincarrera/clash-royale-api](https://codeship.com/projects/4f412dd0-0006-0134-4d8c-1e95689fe79f/status?branch=master)](https://codeship.com/projects/153028) [![Coverage Status](https://coveralls.io/repos/github/martincarrera/clash-royale-api/badge.svg?branch=master)](https://coveralls.io/github/martincarrera/clash-royale-api?branch=master) [![bitHound Overall Score](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/score.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api) [![bitHound Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/dependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Dev Dependencies](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/devDependencies.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/martincarrera/clash-royale-api/badges/code.svg)](https://www.bithound.io/github/martincarrera/clash-royale-api)\n[![donate paypal](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/MartinCarrera)\n\nA [Clash Royale](http://supercell.com/en/games/clashroyale/) API that provides information about the game.\n\n> If you develop an app using this API, please submit a pull request adding it to the [apps table](#apps-that-use-this-api).\n\n## Content\n\n1. [How to use](#how-to-use)\n    1. [Endpoints](#endpoints)\n    2. [Images](#images)\n2. [Want to help](#want-to-help)\n3. [Development](#development)\n    1. [Install](#install)\n    2. [Run](#run)\n    3. [Test](#test)\n4. [Apps that use this API](#apps-that-use-this-api)\n\n## How to use\n\nConsume the API to get all the information you need from these routes.\n\n### Endpoints\n\n[Base route](http://www.clashapi.xyz).\n\n| Route | HTTP Verb | Description |\n|---|---|---|\n| [`/api/arenas`][1] | `GET` | All Arenas information |\n| `/api/arenas/:id` | `GET` | Single Arena information |\n| `/api/arenas/:idName` | `GET` | Single Arena information |\n| [`/api/cards`][2] | `GET` | All Cards information |\n| `/api/cards/:id` | `GET` | Single Card information |\n| `/api/cards/:idName` | `GET` | Single Card information |\n| [`/api/chests`][3] | `GET` | All Chests information |\n| `/api/chests/:id` | `GET` | Single Chest information |\n| `/api/chests/:idName` | `GET` | Single Chest information |\n| [`/api/leagues`][4] | `GET` | All Leagues information |\n| `/api/leagues/:id` | `GET` | Single League information |\n| `/api/leagues/:idName` | `GET` | Single League information |\n| [`/api/players`][5] | `GET` | All Players levels information |\n| `/api/players/:id` | `GET` | Player level information |\n| `/api/players/:idName` | `GET` | Player level information |\n| [`/api/random-deck`][6] | `GET` | Get a Random deck! |\n\n[1]: http://www.clashapi.xyz/api/arenas\n[2]: http://www.clashapi.xyz/api/cards\n[3]: http://www.clashapi.xyz/api/chests\n[4]: http://www.clashapi.xyz/api/leagues\n[5]: http://www.clashapi.xyz/api/players\n[6]: http://www.clashapi.xyz/api/random-deck\n\n### Images\n\nYou can get the images too! Thank you [MaherFa](https://github.com/MaherFa)!\n\n| Route | Description |\n|---|---|\n| [`/images/arenas/${idName}.png`][7] | Arenas images |\n| [`/images/cards/${idName}.png`][8] | Cards images |\n| [`/images/chests/${idName}.png`][9] | Chests images |\n| [`/images/leagues/${idName}.png`][10] | Leagues images |\n\n[7]: http://www.clashapi.xyz/images/arenas/royal-arena.png\n[8]: http://www.clashapi.xyz/images/cards/arrows.png\n[9]: http://www.clashapi.xyz/images/chests/super-magical-chest.png\n[10]: http://www.clashapi.xyz/images/leagues/ultimate-champion.png\n\n## Want to help\n\nIf you like the API, please star this repository.\n\nIf you create an app using the API, please mention this repository and add it in the table below.\n\nIf you want to contribute to the API, feel free to create a pull request.\n\nIf you :heart: the API, [help me pay the hosting](https://www.paypal.me/MartinCarrera)!\n\n## Development\n\nMake sure you have installed all these prerequisites on your development machine.\n\n* [Node.js](https://nodejs.org/en/download/)\n* [MongoDB](https://www.mongodb.org/)\n* [Nodemon](https://nodemon.io/)\n\n### Install\n\n```bash\n> git clone https://github.com/martincarrera/clash-royale-api.git\n> cd clash-royale-api\n> npm install\n```\n\n### Run\n\n```bash\n> mongod\n> cd clash-royale-api\n> npm run dev\n```\n\nIf you don't have `Nodemon` installed\n\n```bash\n> mongod\n> cd clash-royale-api\n> npm i -g nodemon\n> npm run dev\n```\n\n### Test\n\n```bash\n> npm test\n```\n\n## Apps that use this API\n\n| APP | DESCRIPTION | LINK |\n|:---:|:---:|:---:|\n| Randeck | Simple web app that generates random decks. | [Go!](http://randeck.xyz) |\n| Royale Plus | Facebook for Clash Royale players. | [Git!](https://github.com/AmirSavand/royale-plus) [Go!](http://royplus.herokuapp.com/)|\n| BarrePolice | A Telegram Bot based on plugins written in Lua |[Go!](https://t.me/BarrePolice_Bot) _& send /cr_ |\n| Clashapi | NPM package to consume this API | [Go!](https://www.npmjs.com/package/clashapi) |\n| Deck it | Deck builder app designed for Android | [Go!](https://play.google.com/store/apps/details?id=com.oryginal.deckit) |\n| Deck Generator for Echo Devices | Alexa skill to suggest a deck for clash royale for Amazon's Echo devices | [Go!](https://alexa.amazon.in/spa/index.html#skills/dp/B078WSRZWV/?ref=skill_dsk_skb_ca_24) |\n| Clash Royale Discord Bot | A Discord bot that displays informations depending of commands | [Go!](https://github.com/TorzuoliH/clash-royale-discord-bot) |\n| Deck Royale | A SPA using Vue that generates random decks. | [Git!](https://github.com/ikenami/Deck-Royale) [Go!](http://deck-royale-ultimate.herokuapp.com/) |\n| ClashElite | Simple app that gives info on chest cycles and generates random decks with copy and share feature. | [Go!](https://play.google.com/store/apps/details?id=com.wordpress.redmanandroid.clashelite) |\n\nMade with :heart: by clash fans.\n\n----------\nThis content is not affiliated with, endorsed, sponsored, or specifically approved by Supercell and Supercell is not responsible for it. For more information see [Supercell’s Fan Content Policy](http://www.supercell.com/fan-content-policy).\n", 'message': 'Remove bithound badges.', 'author_name': 'GitHub', 'lang': 'md'}