Skip to content

README.md

Latest commit

 

History

History
100 lines (63 loc) · 3.09 KB

README.md

File metadata and controls

100 lines (63 loc) · 3.09 KB
Raw

PKVault - Technical

PKVault project is composed as so:

  • Core package in C# .NET10
  • Backend package
  • Frontend in Typescript/React
  • Desktop app in C# Photino

Backend and Desktop are just consuming the Core as a container. All the logic is in Core !

flowchart TD
    C[Core]
    PF@{ shape: docs, label: "Pokemon files"}
    F[Frontend]

    DW["Windows Desktop"]
    DL["Linux Desktop"]
    DD["Backend (Docker)"]
    DA["Android etc..."]

    WAB{Web-App build}

    subgraph Web-App
        subgraph Core environnement
        C --> PF
        end
    F --> C
    end

    WAB --> Web-App
    DW --> WAB
    DL --> WAB
    DD --> WAB
    DA --> WAB
Loading

Check each package README for more technical documentation.

Quick start

You can target dev & build for desktop Windows app or web app.

Checkout Makefile for all quick commands !

Editor note: all code & its documentation were made with/for VS Code. Any other editor should still work, without warranty.

1 - General preparation

  • Clone this repository including submodules (pokeapi)
  • Run the setup part in frontend

2a - Web app (backend + frontend)

2b - Desktop app

  • From project root, run make apps-prepare (needs tool make)
  • Run the setup & dev parts in PKVault.Desktop

Add new language translations

You can add new language to PKVault if you're willing to make the translations.

Before going further, some disclaimers:

  • Your new language may be partially supported if PKHeX/PokéApi do not support it (ex: Brazilian Portuguese). It will result in a mix between your language and English.

  • AI usage is allowed on the condition that you check the generated code yourself and maintain good code quality.

It is assumed here that you have setup frontend and backend (no need to run them).

  • Find your language code, in lowercase. Ex: en, fr, pt-br, ko, ja-hrkt, zh-hant, ... For the following parts, we'll call it xx.

  • Core part

    • In PKVault.Core/settings/services/SettingsService.cs, add your language code xx to AllowedLanguages.

    • Generate the StaticData files (as described in Scripts README). TL;DR: make static-data-generate This operation can take a few minutes.

  • Frontend part

    • In frontend/src/translate/locales, create xx.json with the content {} for now.

    • In frontend/src/translate/i18n.ts, add your language to resources and languages variables.

    • Run c:translate:fix - this command will check your translations & add missing keys with the placeholder values TBD.

    • Then you just have to add your translations values, based on other translation files (en.json, fr.json, ...). Use c:translate at any moment to see if there is missing values.

  • (Optional) You can also translate functional documentation in docs/functional. These files are used in "Help" modal in-app.

  • Publish your changes and open a PR !