TCGdex/cards-database
1
0
Fork 0
mirror of https://github.com/tcgdex/cards-database.git synced 2025-04-22 10:52:10 +00:00
Code Issues Releases Wiki Activity

Started some reworks of the META files

Browse Source 
Signed-off-by: Avior <florian.bouillon@delta-wings.net>
This commit is contained in:
Florian Bouillon 2021-06-24 00:03:05 +02:00
parent 229f995891
commit 34f3ac9608
Signed by: Florian Bouillon
GPG Key ID: 50BD648F12C86AB6
3 changed files with 106 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,32 @@
# How to contribute
If you are here, I like you already !
## TL::DR
A card is missing or has incorrect informations?
feel free to contribute to the database by adding [an Issue](https://github.com/tcgdex/cards-database/issues/new), [a Discussion](https://github.com/tcgdex/cards-database/discussions/new) or [a Pull Request](https://github.com/tcgdex/cards-database/pulls/compare)
## Database Issue or recomendation
We would love you to see what you can propose to make the Database/API better !
to do this you can check if there is not already an issue/discussion about it, and if there is nothing, add a new [Issues](https://github.com/tcgdex/cards-database/issues/new) if it's already well though, or [create a new discussion](https://github.com/tcgdex/cards-database/discussions/new) to speak about it
## Pushing changes
To send changes to our repository, you will have to follow the next steps:
- Fork 🍴 the project. _see at the top right of the screen_
- make the changes you want in your Repository.
- Create a Pull request here https://github.com/tcgdex/cards-database/compare
- we don't like ❌, so if your pull request has its automated checks ending with the red cross, please double check your change until it show the awesome 🟢, or ask for help !
- If you pull request is ready for review you can go the 🏖️ and we will handle the rest !
## coding Convention
Install in your dev environment the plugin `.editorconfig` is not already done and thats it !
- Indent using `tab`
- don't uglify your code (_why would you even do it_)

24
LICENSE Normal file
View File

@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org>

58
README.md
View File

@ -1,12 +1,32 @@
# Pokemon TCGdex
<p align="center">
<a href="https://www.tcgdex.net">
<img src="https://repository-images.githubusercontent.com/241652591/01dd7200-ca01-11eb-98e0-d8f04e7dfe42" width="50%" alt="Discord Link">
</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/compiler">
<img src="https://img.shields.io/github/workflow/status/tcgdex/compiler/Compile%20TCGdex?style=flat-square" alt="Compiler build passing" />
</a>
</p>
A Multilanguage Pokémon TCG Database with Pictures and most of the informations contained on the cards
# Pokemon TCGdex Cards Database
## Use the datas
A Multilanguage Pokémon TCG Database with Cards Pictures and most of the informations contained on the cards.
The easiest way to use the datas is via our [Javascript/Typescript SDK](https://github.com/tcgdex/javascript-sdk).
## Interact with the Database
You can however build this yourself via our [compiler](https://github.com/tcgdex/compiler) or download the already build [compiled database](https://github.com/tcgdex/distribution).
The easiest way to interact with the database is by using one of our SDKs _list below_.
You can however build the API yourself by using our [compiler](https://github.com/tcgdex/compiler) or download the already built [compiled database](https://github.com/tcgdex/distribution).
## SDKs (API Wrapper but SDK is way cooler 😄)
@ -15,8 +35,30 @@ We currently officially support theses SDKs
- [Javascript/Typescript SDK](https://github.com/tcgdex/javascript-sdk)
- [PHP SDK](https://github.com/tcgdex/php-sdk)
_If you have made a SDK you can start a [discussion](https://github.com/tcgdex/cards-database/discussions/new) to be added here_
_If you have a SDK you can start a [discussion](https://github.com/tcgdex/cards-database/discussions/new) to be added here_
# Contributing
A card is missing or has incorrect informations? feel free to contribute to the database via the [Issues](https://github.com/tcgdex/cards-database/issues) or with a [Pull Request](https://github.com/tcgdex/cards-database/pulls)
## Join Us on Discord
You have a quation or you just want to discuss anything from an idea/improvement to why Furret should be in the next Pokken Tournament game...
Well you can join us on [Discord](https://discord.gg/NehYTAhsZE) !
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md)
TD::DR
- Fork
- make your change
- pull request
## Deprecation
As of February 2021, the v1 API is no longer supported.
## License
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)