tcgdex/server repository overview

⁠

⁠ ⁠ ⁠ ⁠

⁠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

If you need help for using/editing the database, join us on Discord⁠!

⁠Using the Database

The full documentation is available at https://www.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⁠
• PHP SDK⁠
• Java SDK⁠

⁠Editing the Database

There is three sub folders that will allow you to edit some faces of the database

• /data: Contains Cards Data architectured around SerieName/SetName/CardLocalId folders
• /meta: Contains informations for the project (definitions files, Translations for some fields)
• /server: The server that allow to communicate with the database

⁠Status

We are making sure to make every cards available for every languages they were available !

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

⁠Contributing

See CONTRIBUTING.md⁠

TL::DR

• Fork
• make your changes
• pull request

⁠Deprecation

As of February 2021, the v1 API is no longer supported.

⁠Contributors ✨

Thanks goes to these wonderful people (emoji key⁠):

This project follows the all-contributors⁠ specification. Contributions of any kind welcome!

⁠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⁠