1
0
mirror of https://github.com/tcgdex/cards-database.git synced 2025-04-22 02:42:09 +00:00
cards-database/README.md
Florian Bouillon 4dedacee58
docs: Update Code of Conduction, Contributing and templates (#145)
* feat: Add Code of Conduct

this Code of Conduct will be Enforced on the TCGdex's Github and on the TCGdex's Discord

* Update Issue templates

Signed-off-by: Avior <github@avior.me>

* Updated Documents

Signed-off-by: Avior <github@avior.me>
2021-11-08 17:10:19 +01:00

5.1 KiB

TCGdex Main Image

Discord Link Issue count Github stars Compiler build passing All Contributors Badge

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 our Discord server!

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

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

Translations

We have a big effort on translating datas for older sets

note: numbers updated manually

English French German Italian Portuguese Spanish
Cards 14419 9846 6590 6576 6593 6590
Translated 100% 68.2% 45.7% 45.6% 45.7% 45.7%

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):


Avior

💻 🔣

June

🐛

Kevin-Adrea

🐛

Maxopoly

🔣

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