1
0
mirror of https://github.com/tcgdex/cards-database.git synced 2025-04-25 12:22:14 +00:00
cards-database/meta/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

34 lines
956 B
Markdown

# TCGdex META
this folder contains data that allow to build and quickly edit the database
## Codeshift
simple file that contains an easy way to edit multiple entries of the database
run it from the root folder of the project with jscodeshift added using `npm i jscodeshift`
```bash
npx jscodeshift -t ./meta/codeshift.ts --extensions=ts --parser=ts ./data/Serie/Set --print --dry
```
## Definitions
Contains the differents standards of API/Data definition for the built database
- `openapi.yaml`: Open API definition
- `graphql.gql`: GraphQL definitions
- `api.d.ts`: API definition for the SDKs
## Translations
Contains the different translations used by the Compiler that allow to build it in multiple languages
it is managed by the `schema.json` file in the same folder
_note: en.json is not here because it is used as base language_
## legals.ts
File containing the current Standard and Expanded filters for the legal field of each cards