mirror of
https://github.com/tcgdex/cards-database.git
synced 2025-04-22 19:02:10 +00:00
104 lines
5.9 KiB
Markdown
104 lines
5.9 KiB
Markdown
<p align="center">
|
|
<a href="https://www.tcgdex.net">
|
|
<img src="https://www.tcgdex.net/assets/og.png" width="90%" alt="TCGdex Main Image">
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://discord.gg/NehYTAhsZE">
|
|
<img src="https://img.shields.io/discord/857231041261076491?color=%235865F2&label=Discord" alt="Discord Link">
|
|
</a>
|
|
<a href="https://github.com/tcgdex/cards-database/issues">
|
|
<img src="https://img.shields.io/github/issues/tcgdex/cards-database?style=flat-square&color=%2344CC11" alt="Issue count">
|
|
</a>
|
|
<a href="https://github.com/tcgdex/cards-database/stargazers">
|
|
<img src="https://img.shields.io/github/stars/tcgdex/cards-database?style=flat-square" alt="Github stars">
|
|
</a>
|
|
<a href="https://github.com/tcgdex/cards-database/actions">
|
|
<img src="https://img.shields.io/github/actions/workflow/status/TCGdex/cards-database/build.yml?style=flat-square" alt="Compiler build passing" />
|
|
</a>
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
<a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square" alt="All Contributors Badge" /></a>
|
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
</p>
|
|
|
|
# TCGdex - Pokémon TCG Cards Database
|
|
|
|
A Multilanguage Pokémon TCG Database with Cards Pictures and most of the informations contained on the cards.
|
|
|
|
## Getting Started
|
|
|
|
A full documentation of the API is available at <https://tcgdex.dev>
|
|
|
|
- The easiest way to interact with the database is by using one of our SDKs listed below.
|
|
- You can also direcly use the endpoints at `api.tcgdex.net` (see the documentation).
|
|
- You can build the API yourself by using our `Dockerfile` and using it on the port 3000
|
|
|
|
#### SDKs / API Wrappers
|
|
|
|
We currently officially support theses SDKs
|
|
|
|
- [Javascript/Typescript SDK](https://github.com/tcgdex/javascript-sdk)
|
|
- [PHP SDK](https://github.com/tcgdex/php-sdk)
|
|
- [Java SDK](https://github.com/tcgdex/java-sdk)
|
|
|
|
## Status
|
|
|
|
We are making sure to make every cards available for every languages they were available !
|
|
|
|
[](https://api.tcgdex.net/status)
|
|
|
|
_want to help translating? each object fields on cards that have at least en,fr,es,de,it or pt can have the others!,_
|
|
_Also we have another translation files located at `meta/translations`_
|
|
|
|
## Sponsors 💕
|
|
|
|
_[Support us as a sponsor](https://github.com/sponsors/tcgdex) and have your logo featured on our GitHub README, complete with a link to your website._
|
|
|
|
<p align="center">
|
|
<a href="https://dzeio.com" target="_blank" title="Dzeio">
|
|
<img height="128" width="32%" src="./.github/sponsors/dzeio.svg" alt="TCGdex Sponsor Dzeio" />
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<!-- <a href="https://dzeio.com" target="_blank" title="Dzeio"><img height="80" width="19%" src="./.github/sponsors/dzeio.svg" alt="TCGdex Sponsor Dzeio" /></a> -->
|
|
</p>
|
|
|
|
## Contributors ✨
|
|
|
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://www.avior.me/"><img src="https://avatars.githubusercontent.com/u/15822031?v=4?s=100" width="100px;" alt="Avior"/><br /><sub><b>Avior</b></sub></a><br /><a href="https://github.com/tcgdex/cards-database/commits?author=Aviortheking" title="Code">💻</a> <a href="#data-Aviortheking" title="Data">🔣</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/JuneTwooo"><img src="https://avatars.githubusercontent.com/u/1458019?v=4?s=100" width="100px;" alt="June"/><br /><sub><b>June</b></sub></a><br /><a href="https://github.com/tcgdex/cards-database/issues?q=author%3AJuneTwooo" title="Bug reports">🐛</a> <a href="#data-JuneTwooo" title="Data">🔣</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Kevin-Adrea"><img src="https://avatars.githubusercontent.com/u/36231620?v=4?s=100" width="100px;" alt="Kevin-Adrea"/><br /><sub><b>Kevin-Adrea</b></sub></a><br /><a href="https://github.com/tcgdex/cards-database/issues?q=author%3AKevin-Adrea" title="Bug reports">🐛</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Maxopoly"><img src="https://avatars.githubusercontent.com/u/12138136?v=4?s=100" width="100px;" alt="Maxopoly"/><br /><sub><b>Maxopoly</b></sub></a><br /><a href="#data-Maxopoly" title="Data">🔣</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/calli23"><img src="https://avatars.githubusercontent.com/u/24553863?v=4?s=100" width="100px;" alt="calli23"/><br /><sub><b>calli23</b></sub></a><br /><a href="#data-calli23" title="Data">🔣</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="http://imclement.com"><img src="https://avatars.githubusercontent.com/u/1112701?v=4?s=100" width="100px;" alt="Clement Yuan"/><br /><sub><b>Clement Yuan</b></sub></a><br /><a href="#data-spyworldxp" title="Data">🔣</a></td>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Reloadaxe"><img src="https://avatars.githubusercontent.com/u/44167126?v=4?s=100" width="100px;" alt="Benjamin Rousseliere"/><br /><sub><b>Benjamin Rousseliere</b></sub></a><br /><a href="#data-Reloadaxe" title="Data">🔣</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
|
|
|
## Deprecation
|
|
|
|
As of February 2021, the v1 API is no longer supported.
|
|
|
|
## Licenses
|
|
|
|
This database is not produced, endorsed, supported or affiliated with Nintendo or The Pokémon Company
|
|
|
|
The Database is licensed under the MIT License. A copy of the license is available in [LICENSE](./LICENSE)
|